ISISNeutronMuon / ISISNeutronMuon/MDMC
Inherit base class docstrings for properties and methods with different implementations
- Dominant language
- Python
- Stars
- 4
- Forks
- 0
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 5
Description
**Is your feature request related to a problem? Please describe.**
It frequently occurs that a derived class has a different method or property implementation to the base class, however the same docstring. Currently this docstring is an identical copy. Remove this duplication and inherit specific docstrings from base class.
**Describe the solution you'd like**
Create a decorator that can be applied to methods and properties that will use base class docstring. Ensure this satisfies pylint docstring requirement (i.e. doesn't cause pylint to raise no-docstring warning).
**Describe alternatives you've considered**
Just set the method/property __doc__ to the value of super.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.