summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorTim Peters <tim.peters@gmail.com>2004-09-13 15:03:17 (GMT)
committerTim Peters <tim.peters@gmail.com>2004-09-13 15:03:17 (GMT)
commit8278860e520c84351932874ba701a8446a4a10b2 (patch)
treeb3804dfd7fe8c8c3fc505ddaf07ec20b5c54f44a /Doc/lib
parent958cc890370d58b81bf15177f0dfeecff8714394 (diff)
downloadcpython-8278860e520c84351932874ba701a8446a4a10b2.zip
cpython-8278860e520c84351932874ba701a8446a4a10b2.tar.gz
cpython-8278860e520c84351932874ba701a8446a4a10b2.tar.bz2
Document testmod's new exclude_empty argument.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libdoctest.tex14
1 files changed, 11 insertions, 3 deletions
diff --git a/Doc/lib/libdoctest.tex b/Doc/lib/libdoctest.tex
index 374f851..520de5d 100644
--- a/Doc/lib/libdoctest.tex
+++ b/Doc/lib/libdoctest.tex
@@ -525,7 +525,7 @@ are run.
globs}\optional{, verbose}\optional{,
isprivate}\optional{, report}\optional{,
optionflags}\optional{, extraglobs}\optional{,
- raise_on_error}}
+ raise_on_error}\optional{, exclude_empty}}
All arguments are optional, and all except for \var{m} should be
specified in keyword form.
@@ -582,6 +582,14 @@ are run.
in an example. This allows failures to be post-mortem debugged.
Default behavior is to continue running examples.
+ Optional argument \var{exclude_empty} defaults to false. If true,
+ objects for which no doctests are found are excluded from consideration.
+ The default is a backward compatibility hack, so that code still
+ using \method{doctest.master.summarize()} in conjunction with
+ \function{testmod()} continues to get output for objects with no tests.
+ The \var{exclude_empty} argument to the newer \class{DocTestFinder}
+ constructor defaults to true.
+
Optional argument \var{isprivate} specifies a function used to
determine whether a name is private. The default function treats
all names as public. \var{isprivate} can be set to
@@ -593,8 +601,8 @@ are run.
\versionchanged[The parameter \var{optionflags} was added]{2.3}
- \versionchanged[The parameters \var{extraglobs} and \var{raise_on_error}
- were added]{2.4}
+ \versionchanged[The parameters \var{extraglobs}, \var{raise_on_error}
+ and \var{exclude_empty} were added]{2.4}
\end{funcdesc}
\begin{funcdesc}{testsource}{module, name}