Module: testing.skipdoctest

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.

1 Function

IPython.testing.skipdoctest.skip_doctest(f: Any) → Any

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.