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

Support defining specific :private-members: for autodoc #8034

Closed
jtpavlock opened this issue Aug 1, 2020 · 1 comment
Closed

Support defining specific :private-members: for autodoc #8034

jtpavlock opened this issue Aug 1, 2020 · 1 comment
Labels
extensions:autodoc type:enhancement enhance or introduce a new feature
Milestone

Comments

@jtpavlock
Copy link

Is your feature request related to a problem? Please describe.
Currently, if I'm using autodoc, the :private-members: option does not allow specification of which private members to document. The current behavior is to document all private members, but what if I would only like to document 1 or 2?

Describe the solution you'd like
For :private-members: to take arguments, similarly to how :members: currently works

Describe alternatives you've considered
The current best way to do this is to explicitly list each class in a module and use :autoattribute:

@jtpavlock jtpavlock added the type:enhancement enhance or introduce a new feature label Aug 1, 2020
@tk0miya tk0miya added this to the 3.2.0 milestone Aug 1, 2020
@tk0miya tk0miya closed this as completed in d7a84e8 Aug 2, 2020
tk0miya added a commit that referenced this issue Aug 2, 2020
Close #8034: autodoc: :private-member: can take an list of member names
@jtpavlock
Copy link
Author

Wow, thanks for the quick fix!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
extensions:autodoc type:enhancement enhance or introduce a new feature
Projects
None yet
Development

No branches or pull requests

2 participants