lsst.utils  20.0.0-3-g4cc78c6+1c0c6df15e
Functions
lsst.utils.inheritDoc Namespace Reference

Functions

def inheritDoc (klass)
 

Function Documentation

◆ inheritDoc()

def lsst.utils.inheritDoc.inheritDoc (   klass)
Extends 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
----------
klass : object
    The class to inherit documentation from.

Returns
-------
decorator : callable
    Intermediate decorator used in the documentation process.

Definition at line 23 of file inheritDoc.py.