mvpa2.base.dochelpers.borrowdoc

mvpa2.base.dochelpers.borrowdoc(cls, methodname=None)

Return a decorator to borrow docstring from another cls.`methodname`

Parameters :

cls :

Usually a parent class

methodname : None or str

Name of the method from which to borrow. If None, would use the same name as of the decorated method

Examples

To borrow __repr__ docstring from parent class Mapper, do:

@borrowdoc(Mapper)
def __repr__(self):
    ...

NeuroDebian

NITRC-listed