Skip to content
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

Fix #10280: autodoc_docstring_signature generates needless return typehint #10320

Merged

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Apr 2, 2022

Feature or Bugfix

  • Bugfix

Purpose

@tk0miya tk0miya added this to the 5.0.0 milestone Apr 2, 2022
@tk0miya tk0miya force-pushed the 10280_return_typehints_in_docstrings branch from 9f52d7d to 5953791 Compare April 2, 2022 08:11
@tk0miya tk0miya changed the base branch from master to 5.x April 2, 2022 15:36
…return typehint

Basically, autodoc suppresses return value typehint for class
constructors.  But it was unexpectedly shown if
`autodoc_docstring_signature` is enabled and docstring has multiple
signatures.
@tk0miya tk0miya force-pushed the 10280_return_typehints_in_docstrings branch from 59ff18f to a78c07c Compare April 3, 2022 07:32
@tk0miya tk0miya merged commit 4689ec6 into sphinx-doc:5.x Apr 3, 2022
@tk0miya tk0miya deleted the 10280_return_typehints_in_docstrings branch April 3, 2022 07:56
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant