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.
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 test_builtin(self):
"""
Test the built-in random number generator on 10000 numbers.
"""
num_tests = 10000
vals = [0 for i in range(10)]
for i in range(num_tests):
...