From: George Yoshida <dynkin@gmail.com>
Date: Sat, 6 May 2006 13:09:45 +0000 (+0000)
Subject: describe optional arguments for DocFileSuite
X-Git-Tag: v2.5b1~699
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d3d8ecda15fb3c0fe72778e2bdb890e1ab9faffa;p=thirdparty%2FPython%2Fcpython.git

describe optional arguments for DocFileSuite
---

diff --git a/Doc/lib/libdoctest.tex b/Doc/lib/libdoctest.tex
index b318d2a97ad2..5a997d638db1 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}.