Docstrings
Last updated
Was this helpful?
Last updated
Was this helpful?
Reference:
Example (Pandas):
Docstrings allow Python developers to document their code in a way which can be interpreted by other computers and humans alike.
"The docstring for a function or method should summarize its behavior and document its arguments, return value(s), side effects, exceptions raised, and restrictions on when it can be called (all if applicable). Optional arguments should be indicated. It should be documented whether keyword arguments are part of the interface." -
Before documentation:
Complete, with documentation: