##// END OF EJS Templates
Fix documentation: reference.rst (#13044)...
Fix documentation: reference.rst (#13044) The paragraph there was contradicting the information in `ipython --help`

File last commit:

r22960:cf0d4930
r26623:0aa5c32d
Show More
skipdoctest.py
19 lines | 713 B | text/x-python | PythonLexer
"""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