numpy.testing.rundocs()

numpy.testing.rundocs(filename=None, raise_on_error=True) [source]

Run doctests found in the given file.

By default rundocs raises an AssertionError on failure.

Parameters:

Parameters:	filename : str The path to the file for which the doctests are run. raise_on_error : bool Whether to raise an AssertionError when a doctest fails. Default is True.

filename : str

The path to the file for which the doctests are run.

raise_on_error : bool

Whether to raise an AssertionError when a doctest fails. Default is True.

Notes

The doctests can be run by the user/developer by adding the doctests argument to the test() call. For example, to run all tests (including doctests) for numpy.lib:

>>> np.lib.test(doctests=True)

Links:

https://docs.scipy.org/doc/numpy-1.11.0/reference/generated/numpy.testing.rundocs.html

doc_NumPy

2017-01-10 18:19:00

Comments

Popular Articles

Test Support (numpy.testing) Common test support for all numpy test scripts. This single module should provide all the common functionality for numpy tests in a single location,

numpy.testing.assert_raises() numpy.testing.assert_raises(exception_class, callable, *args, **kwargs) [source] Fail unless an exception of class exception_class is thrown by c

numpy.testing.Tester numpy.testing.Tester [source] alias of NoseTester

numpy.testing.decorate_methods() numpy.testing.decorate_methods(cls, decorator, testmatch=None) [source] Apply a decorator to all methods in a class matching a regular expression

numpy.testing.assert_warns() numpy.testing.assert_warns(warning_class, *args, **kwargs) [source] Fail unless the given callable throws the specified warning. A warning of cla