Skip to content
New issue

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

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

Already on GitHub? # to your account

Inherited instance attributes are not documented #477

Closed
AWhetter opened this issue Aug 28, 2024 · 0 comments
Closed

Inherited instance attributes are not documented #477

AWhetter opened this issue Aug 28, 2024 · 0 comments
Labels

Comments

@AWhetter
Copy link
Collaborator

AWhetter commented Aug 28, 2024

class MyBaseException(Exception):
    def __init__(self):
        self.my_message: str = "This is my message"
        """The message."""
        super().__init__(self.my_message)

class MyException(MyBaseException):
    pass
# conf.py
autoapi_options = ['members', 'imported-members', 'inherited-members', 'show-module-summary']

MyException is documented as having not attributes, but it should document the inherited my_message attribute.

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

No branches or pull requests

1 participant