Inherit docstrings from parent classes #339
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
where inherited subclass methods are omitted if they have no docstring,
yet a parent class method has a docstring.
e.g.
If the intention is to document
Derived
and include the inheritedmethods, it would be a surprise if
Derived.m2
is omitted or it isincluded but it has no docstring. As a result to have an option like
include_inherited_docstring
that can befalse
does not alignwith the users expected intentions.