Skip to content

Commit

Permalink
Fix sphinx-doc#8041: autodoc: An ivar on super class is not shown une…
Browse files Browse the repository at this point in the history
…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.
  • Loading branch information
tk0miya committed Aug 2, 2020
1 parent 5be0061 commit 8822c4d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGES
Expand Up @@ -63,6 +63,8 @@ Bugs fixed
when ``:inherited-members:`` option given
* #8032: autodoc: A type hint for the instance variable defined at parent class
is not shown in the document of the derived class
* #8041: autodoc: An annotated instance variable on super class is not
documented when derived class has other annotated instance variables
* #7839: autosummary: cannot handle umlauts in function names
* #7865: autosummary: Failed to extract summary line when abbreviations found
* #7866: autosummary: Failed to extract correct summary line when docstring
Expand Down

0 comments on commit 8822c4d

Please sign in to comment.