aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/ipython/py3/IPython/testing/skipdoctest.py
blob: 64801b6781cda2f13f0d0ec59d2461fb00cec64b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
"""Decorators marks that a doctest should be skipped. 
 
The IPython.testing.decorators module triggers various extra imports, including 
numpy and sympy if they're present. Since this decorator is used in core parts 
of IPython, it's in a separate module so that running IPython doesn't trigger 
those imports.""" 
 
# Copyright (C) IPython Development Team 
# Distributed under the terms of the Modified BSD License. 
 
 
def skip_doctest(f): 
    """Decorator - mark a function or method for skipping its doctest. 
 
    This decorator allows you to mark a function whose docstring you wish to 
    omit from testing, while preserving the docstring for introspection, help, 
    etc.""" 
    f.skip_doctest = True 
    return f