[Python-checkins] python/dist/src/Doc/lib libdoctest.tex,1.56,1.57
tim_one at users.sourceforge.net
tim_one at users.sourceforge.net
Sun Sep 26 22:45:07 CEST 2004
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2067/Doc/lib
Modified Files:
libdoctest.tex
Log Message:
Docs for run_docstring_examples().
Index: libdoctest.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdoctest.tex,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -d -r1.56 -r1.57
--- libdoctest.tex 26 Sep 2004 05:09:59 -0000 1.56
+++ libdoctest.tex 26 Sep 2004 20:45:04 -0000 1.57
@@ -944,6 +944,36 @@
and \var{exclude_empty} were added]{2.4}
\end{funcdesc}
+There's also a function to run the doctests associated with a single object.
+This function is provided for backward compatibility. There are no plans
+to deprecate it, but it's rarely useful:
+
+\begin{funcdesc}{run_docstring_examples}{f, globs\optional{,
+ verbose}\optional{, name}\optional{,
+ compileflags}\optional{, optionflags}}
+
+ Test examples associated with object \var{f}; for example, \var{f} may
+ be a module, function, or class object.
+
+ A shallow copy of dictionary argument \var{globs} is used for the
+ execution context.
+
+ Optional argument \var{name} is used in failure messages, and defaults
+ to \code{"NoName"}.
+
+ If optional argument \var{verbose} is true, output is generated even
+ if there are no failures. By default, output is generated only in case
+ of an example failure.
+
+ Optional argument \var{compileflags} gives the set of flags that should
+ be used by the Python compiler when running the examples. By default, or
+ if \code{None}, flags are deduced corresponding to the set of future
+ features found in \var{globs}.
+
+ Optional argument \var{optionflags} works as for function
+ \function{testfile()} above.
+\end{funcdesc}
+
\subsection{Unittest API\label{doctest-unittest-api}}
As your collection of doctest'ed modules grows, you'll want a way to run
More information about the Python-checkins
mailing list