Repository navigation
Conversation
This branch has not been deployed
This file contains hidden or 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
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.
Purpose
This fixes the
obj_typeargument in theautodoc-skip-memberdocs. autodoc passesthe type of the object whose members are being documented (
'module','class', or'exception'), not the type of the member. Forbarinclass Foo,obj_typeis'class'.It also adds a note that autosummary emits the same event with different arguments:
obj_typeis the member's own type (for example'function'or'method'),skipisalways
False, andoptionsis an empty dict. The autosummary page no longer says itemits the event "as autodoc does".
#14629 already fixed the
nameargument, so this should finish #14555.References
AI Disclosure
I used Claude Code to find where the event is emitted and to draft the wording. I checked
each claim against the code:
_member_finder.py(autodoc passesprops.obj_type, andmembers are only gathered for module, class and exception), the legacy class-based
documenters (same behavior), and both emit sites in
autosummary/generate.py(
_get_documenter(value, parent),False,{}).I confirmed this by running a small test project.