pyufunc.show_docstring_numpy

pyufunc.show_docstring_numpy()

Show numpy docstring style.

References

source https://sphinxcontrib-napoleon.readthedocs.io/en/latest/

Examples

>>> import pyufunc as pf
>>> pf.show_docstring_numpy()
>>> Numpy style annotation:
>>>     def func(arg1: int, arg2: str) -> bool:
>>>         '''Summary line.
>>>
>>>         Extended description of function.
>>>
>>>         Parameters
>>>         ----------
>>>         arg1 : int
>>>             Description of arg1
>>>         arg2 : str
>>>             Description of arg2
>>>
>>>         Returns
>>>         -------
>>>         bool
>>>             Description of return value
>>>
>>>         '''
>>>         return True