Fix #8143: AttributeError if autodoc_default_options contains False #8144
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
…ns False autodoc crahses when autodoc_default_options contains False value unexpectedly. After this change, it also accepts False.
hroncok
reviewed
Aug 21, 2020
| @@ -94,7 +94,10 @@ def members_option(arg: Any) -> Union[object, List[str]]: | |||
| """Used to convert the :members: option to auto directives.""" | |||
| if arg is None or arg is True: | |||
| return ALL | |||
| return [x.strip() for x in arg.split(',') if x.strip()] | |||
| elif arg is False: | |||
| return None | |||
There was a problem hiding this comment.
I would expect EMPTY here. WDYT?
There was a problem hiding this comment.
No, I don't think so. None means the option is not set. And it skips all private-members automatically (as auto* directive does by default). At present, all :members:, :inherited-members: and :private-members: don't become EMPTY. I guess it will break autodoc unexpectedly.
There was a problem hiding this comment.
Thanks for the explanation.
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
unexpectedly. After this change, it also accepts False.