summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorge Yoshida <dynkin@gmail.com>2006-05-06 13:09:45 (GMT)
committerGeorge Yoshida <dynkin@gmail.com>2006-05-06 13:09:45 (GMT)
commitd3d8ecda15fb3c0fe72778e2bdb890e1ab9faffa (patch)
tree97b5d1479a74b80cc0cea4fd43b77ecdeb3db436 /Doc
parent9b83fc67ea121faf843b2b6234b29506619c7a0e (diff)
downloadcpython-d3d8ecda15fb3c0fe72778e2bdb890e1ab9faffa.zip
cpython-d3d8ecda15fb3c0fe72778e2bdb890e1ab9faffa.tar.gz
cpython-d3d8ecda15fb3c0fe72778e2bdb890e1ab9faffa.tar.bz2
describe optional arguments for DocFileSuite
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libdoctest.tex6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/lib/libdoctest.tex b/Doc/lib/libdoctest.tex
index b318d2a..5a997d6 100644
--- a/Doc/lib/libdoctest.tex
+++ b/Doc/lib/libdoctest.tex
@@ -1058,7 +1058,11 @@ runner.run(suite)
There are two main functions for creating \class{\refmodule{unittest}.TestSuite}
instances from text files and modules with doctests:
-\begin{funcdesc}{DocFileSuite}{*paths, **kw}
+\begin{funcdesc}{DocFileSuite}{\optional{module_relative}\optional{,
+ package}\optional{, setUp}\optional{,
+ tearDown}\optional{, globs}\optional{,
+ optionflags}\optional{, parser}}
+
Convert doctest tests from one or more text files to a
\class{\refmodule{unittest}.TestSuite}.