Commit 8278860e authored by Tim Peters's avatar Tim Peters

Document testmod's new exclude_empty argument.

parent 958cc890
...@@ -525,7 +525,7 @@ are run. ...@@ -525,7 +525,7 @@ are run.
globs}\optional{, verbose}\optional{, globs}\optional{, verbose}\optional{,
isprivate}\optional{, report}\optional{, isprivate}\optional{, report}\optional{,
optionflags}\optional{, extraglobs}\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 All arguments are optional, and all except for \var{m} should be
specified in keyword form. specified in keyword form.
...@@ -582,6 +582,14 @@ are run. ...@@ -582,6 +582,14 @@ are run.
in an example. This allows failures to be post-mortem debugged. in an example. This allows failures to be post-mortem debugged.
Default behavior is to continue running examples. 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 Optional argument \var{isprivate} specifies a function used to
determine whether a name is private. The default function treats determine whether a name is private. The default function treats
all names as public. \var{isprivate} can be set to all names as public. \var{isprivate} can be set to
...@@ -593,8 +601,8 @@ are run. ...@@ -593,8 +601,8 @@ are run.
\versionchanged[The parameter \var{optionflags} was added]{2.3} \versionchanged[The parameter \var{optionflags} was added]{2.3}
\versionchanged[The parameters \var{extraglobs} and \var{raise_on_error} \versionchanged[The parameters \var{extraglobs}, \var{raise_on_error}
were added]{2.4} and \var{exclude_empty} were added]{2.4}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{testsource}{module, name} \begin{funcdesc}{testsource}{module, name}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment