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.

Sign up for GitHub

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

Jump to bottom

Inherit docstrings from parent classes #339

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Inherit docstrings from parent classes #339

wants to merge 1 commit into from

Commits on Mar 14, 2024

  1. Inherit docstrings from parent classes 

    This change makes it so that subclass methods that do not have
docstrings inherit a docstring from the first parent class whose
overriden method has a docstring.

It also improves the case for the options

```yaml
include_empty: false
include_inherited: true
```

where inherited subclass methods are omitted if they have no docstring,
yet a parent class method has a docstring.

e.g.

```
class Base:
    def m1(): ...
        """Calculate m1"""

    def m2(): ...
        """Calculate m2"""

class Derived(Base):
    def m2(): ...
```

If the intention is to document `Derived` and include the inherited
methods, it would be a surprise if `Derived.m2` is omitted or it is
included but it has no docstring. As a result to have an option like
`include_inherited_docstring` that can be `false` does not align
with the users expected intentions.
    @has2k1
    has2k1 committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    2bf3510 View commit details
    Browse the repository at this point in the history