Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[autodoc] allow undocumented attributes in __init__ to be picked up by :undoc-members: #11933

Open
wants to merge 17 commits into
base: master
Choose a base branch
from

Conversation

picnixz
Copy link
Member

@picnixz picnixz commented Feb 3, 2024

Fix #10193.

Due to various side-effects, the test suite must currently be executed in its own (see #11285).

@picnixz picnixz added the awaiting:decision PR waiting for a consensus from maintainers. label Mar 3, 2024
@picnixz picnixz marked this pull request as draft March 14, 2024 11:35
@picnixz
Copy link
Member Author

picnixz commented Mar 14, 2024

Converting to draft due to pending decision

@@ -396,6 +396,15 @@ def visit_Assign(self, node: ast.Assign) -> None:

# not commented (record deforders only)
for varname in varnames:
if (
# TODO(picnixz): decide whether to include special names or not
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am considering possibly picking attributes defined in __new__ as well but I think it should be another PR. I don't remember why I used "special" names though...

@picnixz picnixz marked this pull request as ready for review March 28, 2024 08:22
@picnixz picnixz mentioned this pull request Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting:decision PR waiting for a consensus from maintainers. extensions:autodoc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

:undoc-members: option doesn't work for instance attributes
2 participants