# This file is part of
# the galaxy-chop project (https://github.com/vcristiani/galaxy-chop)
# Copyright (c) 2021, Valeria Cristiani
# License: MIT
# Full Text: https://github.com/vcristiani/galaxy-chop/blob/master/LICENSE.txt
# !/usr/bin/env python
# -*- coding: utf-8 -*-
# =============================================================================
# DOCS
# =============================================================================
"""Multiple decorator to use inside scikit-criteria."""
# =============================================================================
# IMPORTS
# =============================================================================
from custom_inherit import doc_inherit as _doc_inherit
# =============================================================================
# DOC INHERITANCE
# =============================================================================
[docs]def 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
py:function:`custom_inherit.doc_inherit decorator`.
Check: <github `https://github.com/rsokl/custom_inherit`>__
"""
return _doc_inherit(parent, style="numpy")