datopy.workflow.doctest_function#

doctest_function(
object: Callable[[...], Any],
globs: dict[str, Any],
verbose=True,
) None[source]#

Convenience wrapper to run doctests for a specific function or class.

Parameters:
  • object (Callable[…, Any]) – Class, function, or other object with doctests to be run.

  • globs (dict[str, Any]) – Global variables from module of interest.

See also

datopy.run_doctests.run_doctest_suite

Simultaneously run all doctests across modules.