From 3787f9960359a2e2912c7e2c9e16da13e0f4951b Mon Sep 17 00:00:00 2001 From: joncrall Date: Sun, 14 Aug 2022 14:42:39 -0400 Subject: [PATCH] Add notes --- src/xdoctest/runner.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/xdoctest/runner.py b/src/xdoctest/runner.py index a84a15e9..5db2abba 100644 --- a/src/xdoctest/runner.py +++ b/src/xdoctest/runner.py @@ -141,7 +141,9 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[], ignores any modname matching any of these glob-like patterns config (Dict[str, object]): - modifies each examples configuration + modifies each examples configuration. Defaults and + expected keys are documented in + :class:`xdoctest.doctest_example.DoctestConfig` durations (int | None): if specified report top N slowest tests @@ -612,6 +614,7 @@ def _parse_commandline(command=None, style='auto', verbose=None, argv=None): command = argv[0] # Change how docstrs are found + # TODO: Undocumented flags. Either document in argparse or remove. if '--freeform' in argv: style = 'freeform' elif '--google' in argv: