Info Fields
Info Fields
In python docstrings these might present as items in the docstrings
:param str name: optional name
- info is that it is a
parameter - follow by type
str - then the name of the param
name - and finally the description
This can also be borken out onto 2 different lines for legibility sake
:param name: optional name
:type name: str
:returns: 'Hello world!' or 'Hello, {name}!'
:rtype: str
:attr block_size: being used to document a class attribute
:raises ValueError: To define the exception it may raise and why it will raise that exception
:meth: for defining methods
Backlinks