Fix #904: autodoc: An instance attribute cause a crash of autofunction #7946
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
904_autofunction_ivar_support
branch
from
a856448
to
610ab92
Compare
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Nov 25, 2020
InstanceAttributeDocumenter is merged into AttributeDocumenter in sphinx-doc#7946 and sphinx-doc#8444. So it is no longer needed now.
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
refs: autodocs does not work well with instance attributes. #904
So far, autofunction only checks the existence of the class variable.
As a result, it crashes with AttributeError if an instance variable is
specified.
This adds an exisitence for instance attributes via ModuleAnalyzer
before getattr-check.