Docstrings
A Python docstring is a string literal. It can occur as the first statement in a module or as the first statement following the definition of a function, method, or class. The docstring becomes the __doc__ special attribute of that thing. Its purpose is to provide a more free-form way to document part of a program.
Example
The following code provides docstrings for an abbreviated version of an earlier test suite:
""" This is an abbreviated version of my random number generator test suite. It uses the pytest framework. It does not do much in this form. """ import numpy as np import scipy.stats import random class TestRandoms( ): """ This is the main class. Normally it would hold all the tests, plus and setup and tearDown fixtures. """ def ...
Get Mastering IPython 4.0 now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
