{ } Raw JSON

bundles / IPython 9.17.0 / IPython / testing / skipdoctest / skip_doctest

function

IPython.testing.skipdoctest:skip_doctest

source: /dev/ipython/IPython/testing/skipdoctest.py:15

Signature

def skip_doctest(f: Any) → Any

Summary

Decorator - mark a function or method for skipping its doctest.

Extended Summary

This decorator allows you to mark a function whose docstring you wish to omit from testing, while preserving the docstring for introspection, help, etc.

Aliases

  • IPython.core.completer.skip_doctest