Fix #9250: autodoc: autodoc_inherited_docstrings doesn't effect to classes #9262
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
tk0miya
force-pushed
the
9250_autodoc_inherited_docstrings_for_classes
branch
from
6618935
to
99e3736
Compare
…fect to classes The docstring of the superclass is not extracted even if the docstring of the subclass is empty and autodoc_inherited_docstrings=True. This adds `sphinx.util.inspect.getclassdoc()` to respect the configuration on getting docstring.
tk0miya
force-pushed
the
9250_autodoc_inherited_docstrings_for_classes
branch
from
99e3736
to
26e861b
Compare
tk0miya
commented
May 23, 2021
| if not allow_inherited: | ||
| return safe_getattr(obj, '__doc__', None) | ||
| else: | ||
| for basecls in getmro(obj)[:-1]: |
There was a problem hiding this comment.
This excepts the object class. But other built-in classes are not excepted yet. So the docstring of list, dict, str, int and so on are fetched. I think it's an unexpected broken change.
There was a problem hiding this comment.
Oh...
>>> inspect.isbuiltin(list)
False
>>> list.__module__
'builtins'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
of the subclass is empty and autodoc_inherited_docstrings=True.
sphinx.util.inspect.getclassdoc()to respect the configurationon getting docstring.