We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Describe the bug
When Docstring format is sphinx the generated field :return: should be named :returns: instead.
sphinx
:return:
:returns:
Versions (please complete the following information):
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
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Describe the bug
When Docstring format is
sphinx
the generated field:return:
should be named:returns:
instead.Versions (please complete the following information):
Original Code (with line to generate on):
Expected Result:
Actual Result:
Additional context
Official Sphinx documentation
The text was updated successfully, but these errors were encountered: