skcriteria.utils.decorators module

Multiple decorator to use inside scikit-criteria.

skcriteria.utils.decorators.doc_inherit(parent)

Inherit the ‘parent’ docstring.

Returns a function/method decorator that, given parent, updates the docstring of the decorated function/method based on the numpy style and the corresponding attribute of parent.

Parameters

parent (Union[str, Any]) – The docstring, or object of which the docstring is utilized as the parent docstring during the docstring merge.

Notes

This decorator is a thin layer over custom_inherit.doc_inherit decorator().

Check: <github https://github.com/rsokl/custom_inherit>__