pyufunc.show_docstring_headers

pyufunc.show_docstring_headers()

Show supported docstring header.

See also

show_google_docstring_style

show_numpy_docstring_style

References

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

Examples

>>> import pyufunc as pf
>>> pf.show_docstring_headers()
>>> This is a general header for google and numpy docstring.
>>>     Args (alias of Parameters)
>>>     Arguments (alias of Parameters)
>>>     Attributes
>>>     Example
>>>     Examples
>>>     Keyword Args (alias of Keyword Arguments)
>>>     Keyword Arguments
>>>     Methods
>>>     Note
>>>     Notes
>>>     Other Parameters
>>>     Parameters
>>>     Return (alias of Returns)
>>>     Returns
>>>     Raises
>>>     References
>>>     See Also
>>>     Todo
>>>     Warning
>>>     Warnings (alias of Warning)
>>>     Warns
>>>     Yield (alias of Yields)
>>>     Yields