autodoc: the signature of base function will be shown for decorated functions #7916
Conversation
This file contains 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
harupy
reviewed
Aug 11, 2020
| sig = inspect.signature(self.object, follow_wrapped=True) | ||
| else: | ||
| sig = inspect.signature(self.object) | ||
| sig = inspect.signature(self.object, follow_wrapped=True) |
There was a problem hiding this comment.
@tk0miya Should we specify follow_wrapeed=True in inspect.signature in ClassDocumenter as well otherwise a wrapper function's signature (e.g. (*args, **kwargs)) would be used when __init__ is decorated?
sphinx/sphinx/ext/autodoc/__init__.py
Line 1401 in 38b868c
There was a problem hiding this comment.
The same goes for the line below:
sphinx/sphinx/ext/autodoc/type_comment.py
Line 122 in 38b868c
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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