Skip to content

Fix napoleon handling of numpy docstrings with no explicitly provided return type #311

New issue

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

Merged
merged 2 commits into from
Jan 20, 2023

Conversation

hoodmane
Copy link
Collaborator

If there is no explicitly provided return type, napoleon will incorrectly parse the entire return type explanation. It can be fixed by inserting a line with a single colon at the beginning of the returns section.

… return type

If there is no explicitly provided return type, napoleon will incorrectly parse
the entire return type explanation. It can be fixed by inserting a line with a
single colon at the beginning of the returns section.
Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changelog please.

@hoodmane
Copy link
Collaborator Author

Done.

@gaborbernat gaborbernat merged commit 3aca67b into tox-dev:main Jan 20, 2023
@hoodmane hoodmane deleted the numpy-docstring-return-type branch January 20, 2023 19:46
basnijholt added a commit to pipefunc/pipefunc that referenced this pull request Jun 1, 2024
Seemed initially blocked by 
- numpy/numpydoc#356
- sphinx-doc/sphinx#7077
- numpy/numpydoc#251 (comment)

However, fixed by finding this comment sphinx-doc/sphinx#7077 (comment) which pointed to tox-dev/sphinx-autodoc-typehints#311
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants