To provide the most recent news and documentation www.pymvpa.org reflects the development 2.0 series (renamed 0.6 series) of PyMVPA. If you are interested in the documentation of the previous stable 0.4 series of PyMVPA, please visit v04.pymvpa.org.

mvpa2.misc.neighborhood.borrowkwargs

mvpa2.misc.neighborhood.borrowkwargs(cls, methodname=None, exclude=None)

Return a decorator which would borrow docstring for **kwargs

Parameters :

methodname : None or str

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

exclude : None or list of arguments to exclude

If function does not pass all **kwargs, you would need to list those here to be excluded from borrowed docstring

Notes

TODO: take care about *args in a clever way if those are also present

Examples

In the simplest scenario – just grab all arguments from parent class:

@borrowkwargs(A)
def met1(self, bu, **kwargs):
    pass