PyDocs

Nav

Development Tools

run_docstring_examples

doctest

function (source)
  • run_docstring_examples(f, globs, verbose=False, name='NoName', compileflags=None, optionflags=0)
Test examples in the given object's docstring (`f`), using `globs`
as globals.  Optional argument `name` is used in failure messages.
If the optional argument `verbose` is true, then generate output
even if there are no failures.

`compileflags` gives the set of flags that should be used by the
Python compiler when running the examples.  If not specified, then
it will default to the set of future-import flags that apply to
`globs`.

Optional keyword arg `optionflags` specifies options for the
testing and output.  See the documentation for `testmod` for more
information.
0 Examples
No examples for doctest/run_docstring_examples.
See Also
No see-alsos for doctest/run_docstring_examples
0 Notes
No notes for run_docstring_examples