Doc string tests

docstring.py

def add(a, b):
    """
    This is a function that implements adding
    >>> from aide_design.play import *
    >>> import math
    >>> add(5, 10)
    15
    >>> add(25*u.m,5*u.m)
    30 meter
    >>> np.sqrt(2)
    1.414213562373095
    """
    return a+b


import doctest
doctest.testmod(verbose=True)

This is an example of how to include tests within your code. These tests can be run by running the final two lines of code. It is best practice to include these examples/tests within your code. They help communicate how to use your library AND they can be used for regression testing AND they can be used for test driven development. Here's a video going into a bit more detail. And here is the FULL documentation on doctest!