Numpydoc

PHOTO EMBED

Wed Apr 27 2022 07:15:56 GMT+0000 (Coordinated Universal Time)

Saved by @isaackmungui #python

"""
My numpydoc description of a kind
of very exhautive numpydoc format docstring.

Parameters
----------
first : array_like
    the 1st param name `first`
second :
    the 2nd param
third : {'value', 'other'}, optional
    the 3rd param, by default 'value'

Returns
-------
string
    a value in a string

Raises
------
KeyError
    when a key error
OtherError
    when an other error
"""
content_copyCOPY

https://stackoverflow.com/questions/3898572/what-are-the-most-common-python-docstring-formats