]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Reduce warning count from partparse.py.
authorFred Drake <fdrake@acm.org>
Mon, 29 Dec 1997 18:53:31 +0000 (18:53 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 29 Dec 1997 18:53:31 +0000 (18:53 +0000)
Doc/libmacic.tex
Doc/libmacos.tex
Doc/mac/libmacic.tex
Doc/mac/libmacos.tex

index fd1600299bb937f15c63860dca1d31c3fc004aa1..d797cfa0a3c0326e9e6bf8fee8fda2abac9d3a4c 100644 (file)
@@ -22,7 +22,7 @@ names for all error codes IC can produce, see the source for details.
 
 The \code{ic} module defines the following functions:
 
-\begin{funcdesc}{IC}{\optional{signature\, ic}}
+\begin{funcdesc}{IC}{\optional{signature, ic}}
 Create an internet config object. The signature is a 4-char creator
 code of the current application (default \code{'Pyth'}) which may
 influence some of ICs settings. The optional \var{ic} argument is a
@@ -30,14 +30,13 @@ low-level \code{icinstance} created beforehand, this may be useful if
 you want to get preferences from a different config file, etc.
 \end{funcdesc}
 
-\begin{funcdesc}{launchurl}{url \optional{\, hint}}
+\begin{funcdesc}{launchurl}{url \optional{, hint}}
 \end{funcdesc}
-\begin{funcdesc}{parseurl}{data \optional{\, start\, end\, hint}}
+\begin{funcdesc}{parseurl}{data \optional{, start, end, hint}}
 \end{funcdesc}
 \begin{funcdesc}{mapfile}{file}
 \end{funcdesc}
-\begin{funcdesc}{maptypecreator}{type\, creator \optional{\,
-       filename}}
+\begin{funcdesc}{maptypecreator}{type, creator \optional{, filename}}
 \end{funcdesc}
 \begin{funcdesc}{settypecreator}{file}
 These functions are ``shortcuts'' to the methods of the same name,
@@ -66,14 +65,14 @@ Besides the dictionary interface IC objects have the following methods:
 
 \renewcommand{\indexsubitem}{(IC object attribute)}
 
-\begin{funcdesc}{launchurl}{url \optional{\, hint}}
+\begin{funcdesc}{launchurl}{url \optional{, hint}}
 Parse the given URL, lauch the correct application and pass it the
 URL. The optional \var{hint} can be a scheme name such as
 \code{mailto:}, in which case incomplete URLs are completed with this
 scheme (otherwise incomplete URLs are invalid). 
 \end{funcdesc}
 
-\begin{funcdesc}{parseurl}{data \optional{\, start\, end\, hint}}
+\begin{funcdesc}{parseurl}{data \optional{, start, end, hint}}
 Find an URL somewhere in \var{data} and return start position, end
 position and the URL. The optional \var{start} and \var{end} can be
 used to limit the search, so for instance if a user clicks in a long
@@ -88,9 +87,10 @@ Return the mapping entry for the given \var{file}, which can be passed
 as either a filename or an \var{FSSpec} object, and which need not
 exist.
 
-The mapping entry is returned as a tuple \code{(version\, type\,
-creator\, postcreator\, flags\, extension\, appname\, postappname\,
-mimetype\, entryname)}, where \var{version} is the entry version
+The mapping entry is returned as a tuple \code{(}\var{version},
+\var{type}, \var{creator}, \var{postcreator}, \var{flags},
+\var{extension}, \var{appname}, \var{postappname}, \var{mimetype},
+\var{entryname}\code{)}, where \var{version} is the entry version
 number, \var{type} is the 4-char filetype, \var{creator} is the 4-char
 creator type, \var{postcreator} is the 4-char creator code of an
 optional application to post-process the file after downloading,
@@ -102,8 +102,7 @@ postprocessing application, \var{mimetype} is the MIME type of this
 file and \var{entryname} is the name of this entry.
 \end{funcdesc}
 
-\begin{funcdesc}{maptypecreator}{type\, creator \optional{\,
-       filename}}
+\begin{funcdesc}{maptypecreator}{type, creator \optional{, filename}}
 Return the mapping entry for files with given 4-char \var{type} and
 \var{creator} codes. The optional \var{filename} may be specified to
 further help finding the correct entry (if the creator code is
index 785a0b7e45ead4c395e63532b9c300e428212c43..3d1f2347141bf09fdaa051c0be3b8e9cba20df9d 100644 (file)
@@ -32,8 +32,7 @@ Call SetEventHandler without parameter to clear the event handler. Setting
 an eventhandler while one is already set is an error.
 \end{funcdesc}
 
-\begin{funcdesc}{SchedParams}{\optional{doint\, evtmask\, besocial\, 
-                               interval\, bgyield}}
+\begin{funcdesc}{SchedParams}{\optional{doint, evtmask, besocial, interval, bgyield}}
 Influence the interpreter inner loop event handling. \var{Interval}
 specifies how often (in seconds, floating point) the interpreter
 should enter the event processing code. When true, \var{doint} causes
@@ -75,7 +74,7 @@ early in initialization without first having to load numerous
 extension modules.
 \end{funcdesc}
 
-\begin{funcdesc}{DebugStr}{message \optional{\, object}}
+\begin{funcdesc}{DebugStr}{message \optional{, object}}
 Drop to the low-level debugger with message \var{message}. The
 optional \var{object} argument is not used, but can easily be
 inspected from the debugger.
@@ -86,7 +85,7 @@ system. It is intended mainly for developers of Python extension
 modules.
 \end{funcdesc}
 
-\begin{funcdesc}{openrf}{name \optional{\, mode}}
+\begin{funcdesc}{openrf}{name \optional{, mode}}
 Open the resource fork of a file. Arguments are the same as for the
 builtin function \code{open}. The object returned has file-like
 semantics, but it is not a python file object, so there may be subtle
index fd1600299bb937f15c63860dca1d31c3fc004aa1..d797cfa0a3c0326e9e6bf8fee8fda2abac9d3a4c 100644 (file)
@@ -22,7 +22,7 @@ names for all error codes IC can produce, see the source for details.
 
 The \code{ic} module defines the following functions:
 
-\begin{funcdesc}{IC}{\optional{signature\, ic}}
+\begin{funcdesc}{IC}{\optional{signature, ic}}
 Create an internet config object. The signature is a 4-char creator
 code of the current application (default \code{'Pyth'}) which may
 influence some of ICs settings. The optional \var{ic} argument is a
@@ -30,14 +30,13 @@ low-level \code{icinstance} created beforehand, this may be useful if
 you want to get preferences from a different config file, etc.
 \end{funcdesc}
 
-\begin{funcdesc}{launchurl}{url \optional{\, hint}}
+\begin{funcdesc}{launchurl}{url \optional{, hint}}
 \end{funcdesc}
-\begin{funcdesc}{parseurl}{data \optional{\, start\, end\, hint}}
+\begin{funcdesc}{parseurl}{data \optional{, start, end, hint}}
 \end{funcdesc}
 \begin{funcdesc}{mapfile}{file}
 \end{funcdesc}
-\begin{funcdesc}{maptypecreator}{type\, creator \optional{\,
-       filename}}
+\begin{funcdesc}{maptypecreator}{type, creator \optional{, filename}}
 \end{funcdesc}
 \begin{funcdesc}{settypecreator}{file}
 These functions are ``shortcuts'' to the methods of the same name,
@@ -66,14 +65,14 @@ Besides the dictionary interface IC objects have the following methods:
 
 \renewcommand{\indexsubitem}{(IC object attribute)}
 
-\begin{funcdesc}{launchurl}{url \optional{\, hint}}
+\begin{funcdesc}{launchurl}{url \optional{, hint}}
 Parse the given URL, lauch the correct application and pass it the
 URL. The optional \var{hint} can be a scheme name such as
 \code{mailto:}, in which case incomplete URLs are completed with this
 scheme (otherwise incomplete URLs are invalid). 
 \end{funcdesc}
 
-\begin{funcdesc}{parseurl}{data \optional{\, start\, end\, hint}}
+\begin{funcdesc}{parseurl}{data \optional{, start, end, hint}}
 Find an URL somewhere in \var{data} and return start position, end
 position and the URL. The optional \var{start} and \var{end} can be
 used to limit the search, so for instance if a user clicks in a long
@@ -88,9 +87,10 @@ Return the mapping entry for the given \var{file}, which can be passed
 as either a filename or an \var{FSSpec} object, and which need not
 exist.
 
-The mapping entry is returned as a tuple \code{(version\, type\,
-creator\, postcreator\, flags\, extension\, appname\, postappname\,
-mimetype\, entryname)}, where \var{version} is the entry version
+The mapping entry is returned as a tuple \code{(}\var{version},
+\var{type}, \var{creator}, \var{postcreator}, \var{flags},
+\var{extension}, \var{appname}, \var{postappname}, \var{mimetype},
+\var{entryname}\code{)}, where \var{version} is the entry version
 number, \var{type} is the 4-char filetype, \var{creator} is the 4-char
 creator type, \var{postcreator} is the 4-char creator code of an
 optional application to post-process the file after downloading,
@@ -102,8 +102,7 @@ postprocessing application, \var{mimetype} is the MIME type of this
 file and \var{entryname} is the name of this entry.
 \end{funcdesc}
 
-\begin{funcdesc}{maptypecreator}{type\, creator \optional{\,
-       filename}}
+\begin{funcdesc}{maptypecreator}{type, creator \optional{, filename}}
 Return the mapping entry for files with given 4-char \var{type} and
 \var{creator} codes. The optional \var{filename} may be specified to
 further help finding the correct entry (if the creator code is
index 785a0b7e45ead4c395e63532b9c300e428212c43..3d1f2347141bf09fdaa051c0be3b8e9cba20df9d 100644 (file)
@@ -32,8 +32,7 @@ Call SetEventHandler without parameter to clear the event handler. Setting
 an eventhandler while one is already set is an error.
 \end{funcdesc}
 
-\begin{funcdesc}{SchedParams}{\optional{doint\, evtmask\, besocial\, 
-                               interval\, bgyield}}
+\begin{funcdesc}{SchedParams}{\optional{doint, evtmask, besocial, interval, bgyield}}
 Influence the interpreter inner loop event handling. \var{Interval}
 specifies how often (in seconds, floating point) the interpreter
 should enter the event processing code. When true, \var{doint} causes
@@ -75,7 +74,7 @@ early in initialization without first having to load numerous
 extension modules.
 \end{funcdesc}
 
-\begin{funcdesc}{DebugStr}{message \optional{\, object}}
+\begin{funcdesc}{DebugStr}{message \optional{, object}}
 Drop to the low-level debugger with message \var{message}. The
 optional \var{object} argument is not used, but can easily be
 inspected from the debugger.
@@ -86,7 +85,7 @@ system. It is intended mainly for developers of Python extension
 modules.
 \end{funcdesc}
 
-\begin{funcdesc}{openrf}{name \optional{\, mode}}
+\begin{funcdesc}{openrf}{name \optional{, mode}}
 Open the resource fork of a file. Arguments are the same as for the
 builtin function \code{open}. The object returned has file-like
 semantics, but it is not a python file object, so there may be subtle