What is a docstring?
- docstring
- documentation
- help
A documentation string, or docstring in short, is a string that appears at the beginning of a function, class, or module declaration and has the purpose of documenting that construct.
It is accessible from obj.__doc__
and with help()
, and can also be used to create doctests.