inheritDoc¶
- lsst.utils.inheritDoc(klass: type) Callable ¶
Extend existing documentation for a method that exists in another class and extend it with any additional documentation defined.
This decorator takes a class from which to draw documentation from as an argument. This is so that any class may be used as a source of documentation and not just the immediate parent of a class. This is useful when there may be a long inheritance chain, or in the case of mixins.
- Parameters:
- klassobject
The class to inherit documentation from.
- Returns:
- decoratorcallable
Intermediate decorator used in the documentation process.