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

Don't show special-members when enabling inherited-members #464

Closed
q-wertz opened this issue Jul 21, 2024 · 2 comments
Closed

Don't show special-members when enabling inherited-members #464

q-wertz opened this issue Jul 21, 2024 · 2 comments

Comments

@q-wertz
Copy link

q-wertz commented Jul 21, 2024

Hello,

not sure if I misunderstood something or this is related to (or the same as in) #417.

If I have the following config:

autoapi_options = [
    "members",
    "inherited-members",  # disabled by default
    "undoc-members",
    # "special-members",  # disabled by default
    # "private-members",
    "show-inheritance",
    "show-inheritance-diagram",  # disabled by default
    "show-module-summary",
    "special-members",
    "imported-members",
]

in my conf.py file in my understanding there should not be any special-member displayed in the derived classes.

It seems to work for most cases (derived from my own superclass or from abc.ABC), but in the documentation of enums (derived from enum.Enum) special members like __repr__(), __str__(), ... are displayed.

@AWhetter
Copy link
Collaborator

You have special-members included twice. It's commented out once and present again as the second to last item in the list.

@q-wertz
Copy link
Author

q-wertz commented Jul 25, 2024

OMG 🤦‍♂️
Sorry. Codeblind apparently

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants