- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
inherited-members should support more than one class #8417
Comments
+1: Acceptable change. |
For example, there is a class that inherits multiple base classes:
and
How should the new Note: The current behavior is ignoring Parent2, Parent3, and the super classes of them (including Parent1's also). In python words, the classes after |
…multiple classes It allows to suppress inherited members of several classes on the module at once by specifying the option to `automodule` directive
…multiple classes It allows to suppress inherited members of several classes on the module at once by specifying the option to `automodule` directive
…ist_of_classes Close #8417: autodoc: :inherited-members: option now takes multiple classes
Is your feature request related to a problem? Please describe.
I have two situations:
Describe the solution you'd like
The :inherited-members: option to automodule should accept a list of classes. If any of these classes are encountered as base classes when instantiating autoclass documentation, they should be ignored.
Describe alternatives you've considered
The alternative is to not use automodule, but instead manually enumerate several autoclass blocks for a module. This only addresses the second bullet in the problem description and not the first. It is also tedious for modules containing many class definitions.
The text was updated successfully, but these errors were encountered: