]> granicus.if.org Git - python/commitdiff
describe optional arguments for DocFileSuite
authorGeorge Yoshida <dynkin@gmail.com>
Sat, 6 May 2006 13:09:45 +0000 (13:09 +0000)
committerGeorge Yoshida <dynkin@gmail.com>
Sat, 6 May 2006 13:09:45 +0000 (13:09 +0000)
Doc/lib/libdoctest.tex

index b318d2a97ad24334df0baed0ab8cf969b1d427ad..5a997d638db182fbeb6c584b6081b92176359a1c 100644 (file)
@@ -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}.