autoDocstring icon indicating copy to clipboard operation
autoDocstring copied to clipboard

return field should be named "returns"

Open sujuka99 opened this issue 2 years ago • 0 comments
trafficstars

Describe the bug

When Docstring format is sphinx the generated field :return: should be named :returns: instead.

Versions (please complete the following information):

  • autoDocstring Version: 0.6.1
  • Operating System: Linux
  • Vscode Version: 1.77.3

Original Code (with line to generate on):

def example_func():
	# generate on this line
	return "something"

Expected Result:

def example_func():
    """_summary_

    :returns: _description_
    :rtype: _type_
    """
    return True

Actual Result:

def example_func():
    """_summary_

    :return: _description_
    :rtype: _type_
    """
    return True

Additional context Official Sphinx documentation

sujuka99 avatar May 02 '23 17:05 sujuka99