Fix #8041: autodoc: An ivar on super class is not shown unexpectedly #8042
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
8041_ivar_on_superclass_not_shown
branch
from
8822c4d to
cfa0c91
Compare
…xpectedly An annotated instance variable on super class is not documented when derived class has also other annotated instance variables because `obj.__annotations__` is overrided by derived class's type hints. To get annotations of the target class correctly, this scans MRO to get all of annotated instance variables.
tk0miya
force-pushed
the
8041_ivar_on_superclass_not_shown
branch
from
cfa0c91 to
88b2ec6
Compare
tk0miya
commented
Aug 7, 2020
| '', | ||
| ' .. py:attribute:: Derived.attr3', | ||
| ' :module: target.typed_vars', | ||
| ' :value: 0', |
There was a problem hiding this comment.
Note: type_comment in super class is still not supported.
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
derived class has also other annotated instance variables because
obj.__annotations__is overrided by derived class's type hints.get all of annotated instance variables.