Fix autodoc_docstring_signature support for __init__ and __new__#9518
Merged
tk0miya merged 1 commit intosphinx-doc:4.xfrom Aug 1, 2021
Merged
Conversation
The `MethodDocumenter.get_doc` method added by 51ae283 prevents DocstringSignatureMixin from working correctly for __init__ and __new__ methods. Additionally, the __new__ docstring was not obtained correctly. This commit checks for `self._new_docstrings` being set, and also corrects the logic for obtaining the __new__ docstring. There still remains the issue that when the class signature is obtained from the signature of __init__ or __new__, only the real signature is used, due to the use of `sphinx.util.inspect.signature`; the autodoc_docstring_signature option does not have any effect.
Member
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
The
MethodDocumenter.get_docmethod added by51ae283 prevents
DocstringSignatureMixinfrom working correctly for__init__and__new__methods. Additionally, the__new__docstring was not obtainedcorrectly.
This commit checks for
self._new_docstringsbeing set, and alsocorrects the logic for obtaining the
__new__docstring.There still remains the issue that when the class signature is
obtained from the signature of
__init__or__new__, only the realsignature is used, due to the use of
sphinx.util.inspect.signature;the
autodoc_docstring_signatureoption does not have any effect.