mardi 8 septembre 2015

How can I prevent django test from running examples in docstrings?

In my code I have:

def fn1():
    """
    fn1 description

    Parameters
    ----------
    components_list : list
        List of IDs of the reference groups

    Return
    ------
    ret : str
        A string representing the aggregate expression (See example)

    Example
    -------
    >>> reference_groups = [1,2,3,4]
    >>> expression = suite.getComponentsExpression(reference_groups)
        (tier1 and tier2) or (my_group)
    """ 
    #some code here

When I run: ./manage.py test, it tries to run the example. Is there a way to prevent this from happening? e.g. maybe CLI option to skip docstrings

Aucun commentaire:

Enregistrer un commentaire