Commit 671fe9dd authored by Fred Drake's avatar Fred Drake

Reduce warning count from partparse.py.

parent a3e672b5
...@@ -22,7 +22,7 @@ names for all error codes IC can produce, see the source for details. ...@@ -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: 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 Create an internet config object. The signature is a 4-char creator
code of the current application (default \code{'Pyth'}) which may code of the current application (default \code{'Pyth'}) which may
influence some of ICs settings. The optional \var{ic} argument is a 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 ...@@ -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. you want to get preferences from a different config file, etc.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{launchurl}{url \optional{\, hint}} \begin{funcdesc}{launchurl}{url \optional{, hint}}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{parseurl}{data \optional{\, start\, end\, hint}} \begin{funcdesc}{parseurl}{data \optional{, start, end, hint}}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{mapfile}{file} \begin{funcdesc}{mapfile}{file}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{maptypecreator}{type\, creator \optional{\, \begin{funcdesc}{maptypecreator}{type, creator \optional{, filename}}
filename}}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{settypecreator}{file} \begin{funcdesc}{settypecreator}{file}
These functions are ``shortcuts'' to the methods of the same name, 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: ...@@ -66,14 +65,14 @@ Besides the dictionary interface IC objects have the following methods:
\renewcommand{\indexsubitem}{(IC object attribute)} \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 Parse the given URL, lauch the correct application and pass it the
URL. The optional \var{hint} can be a scheme name such as URL. The optional \var{hint} can be a scheme name such as
\code{mailto:}, in which case incomplete URLs are completed with this \code{mailto:}, in which case incomplete URLs are completed with this
scheme (otherwise incomplete URLs are invalid). scheme (otherwise incomplete URLs are invalid).
\end{funcdesc} \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 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 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 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 ...@@ -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 as either a filename or an \var{FSSpec} object, and which need not
exist. exist.
The mapping entry is returned as a tuple \code{(version\, type\, The mapping entry is returned as a tuple \code{(}\var{version},
creator\, postcreator\, flags\, extension\, appname\, postappname\, \var{type}, \var{creator}, \var{postcreator}, \var{flags},
mimetype\, entryname)}, where \var{version} is the entry version \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 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 creator type, \var{postcreator} is the 4-char creator code of an
optional application to post-process the file after downloading, optional application to post-process the file after downloading,
...@@ -102,8 +102,7 @@ postprocessing application, \var{mimetype} is the MIME type of this ...@@ -102,8 +102,7 @@ postprocessing application, \var{mimetype} is the MIME type of this
file and \var{entryname} is the name of this entry. file and \var{entryname} is the name of this entry.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{maptypecreator}{type\, creator \optional{\, \begin{funcdesc}{maptypecreator}{type, creator \optional{, filename}}
filename}}
Return the mapping entry for files with given 4-char \var{type} and Return the mapping entry for files with given 4-char \var{type} and
\var{creator} codes. The optional \var{filename} may be specified to \var{creator} codes. The optional \var{filename} may be specified to
further help finding the correct entry (if the creator code is further help finding the correct entry (if the creator code is
......
...@@ -32,8 +32,7 @@ Call SetEventHandler without parameter to clear the event handler. Setting ...@@ -32,8 +32,7 @@ Call SetEventHandler without parameter to clear the event handler. Setting
an eventhandler while one is already set is an error. an eventhandler while one is already set is an error.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{SchedParams}{\optional{doint\, evtmask\, besocial\, \begin{funcdesc}{SchedParams}{\optional{doint, evtmask, besocial, interval, bgyield}}
interval\, bgyield}}
Influence the interpreter inner loop event handling. \var{Interval} Influence the interpreter inner loop event handling. \var{Interval}
specifies how often (in seconds, floating point) the interpreter specifies how often (in seconds, floating point) the interpreter
should enter the event processing code. When true, \var{doint} causes should enter the event processing code. When true, \var{doint} causes
...@@ -75,7 +74,7 @@ early in initialization without first having to load numerous ...@@ -75,7 +74,7 @@ early in initialization without first having to load numerous
extension modules. extension modules.
\end{funcdesc} \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 Drop to the low-level debugger with message \var{message}. The
optional \var{object} argument is not used, but can easily be optional \var{object} argument is not used, but can easily be
inspected from the debugger. inspected from the debugger.
...@@ -86,7 +85,7 @@ system. It is intended mainly for developers of Python extension ...@@ -86,7 +85,7 @@ system. It is intended mainly for developers of Python extension
modules. modules.
\end{funcdesc} \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 Open the resource fork of a file. Arguments are the same as for the
builtin function \code{open}. The object returned has file-like builtin function \code{open}. The object returned has file-like
semantics, but it is not a python file object, so there may be subtle semantics, but it is not a python file object, so there may be subtle
......
...@@ -22,7 +22,7 @@ names for all error codes IC can produce, see the source for details. ...@@ -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: 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 Create an internet config object. The signature is a 4-char creator
code of the current application (default \code{'Pyth'}) which may code of the current application (default \code{'Pyth'}) which may
influence some of ICs settings. The optional \var{ic} argument is a 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 ...@@ -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. you want to get preferences from a different config file, etc.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{launchurl}{url \optional{\, hint}} \begin{funcdesc}{launchurl}{url \optional{, hint}}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{parseurl}{data \optional{\, start\, end\, hint}} \begin{funcdesc}{parseurl}{data \optional{, start, end, hint}}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{mapfile}{file} \begin{funcdesc}{mapfile}{file}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{maptypecreator}{type\, creator \optional{\, \begin{funcdesc}{maptypecreator}{type, creator \optional{, filename}}
filename}}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{settypecreator}{file} \begin{funcdesc}{settypecreator}{file}
These functions are ``shortcuts'' to the methods of the same name, 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: ...@@ -66,14 +65,14 @@ Besides the dictionary interface IC objects have the following methods:
\renewcommand{\indexsubitem}{(IC object attribute)} \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 Parse the given URL, lauch the correct application and pass it the
URL. The optional \var{hint} can be a scheme name such as URL. The optional \var{hint} can be a scheme name such as
\code{mailto:}, in which case incomplete URLs are completed with this \code{mailto:}, in which case incomplete URLs are completed with this
scheme (otherwise incomplete URLs are invalid). scheme (otherwise incomplete URLs are invalid).
\end{funcdesc} \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 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 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 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 ...@@ -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 as either a filename or an \var{FSSpec} object, and which need not
exist. exist.
The mapping entry is returned as a tuple \code{(version\, type\, The mapping entry is returned as a tuple \code{(}\var{version},
creator\, postcreator\, flags\, extension\, appname\, postappname\, \var{type}, \var{creator}, \var{postcreator}, \var{flags},
mimetype\, entryname)}, where \var{version} is the entry version \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 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 creator type, \var{postcreator} is the 4-char creator code of an
optional application to post-process the file after downloading, optional application to post-process the file after downloading,
...@@ -102,8 +102,7 @@ postprocessing application, \var{mimetype} is the MIME type of this ...@@ -102,8 +102,7 @@ postprocessing application, \var{mimetype} is the MIME type of this
file and \var{entryname} is the name of this entry. file and \var{entryname} is the name of this entry.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{maptypecreator}{type\, creator \optional{\, \begin{funcdesc}{maptypecreator}{type, creator \optional{, filename}}
filename}}
Return the mapping entry for files with given 4-char \var{type} and Return the mapping entry for files with given 4-char \var{type} and
\var{creator} codes. The optional \var{filename} may be specified to \var{creator} codes. The optional \var{filename} may be specified to
further help finding the correct entry (if the creator code is further help finding the correct entry (if the creator code is
......
...@@ -32,8 +32,7 @@ Call SetEventHandler without parameter to clear the event handler. Setting ...@@ -32,8 +32,7 @@ Call SetEventHandler without parameter to clear the event handler. Setting
an eventhandler while one is already set is an error. an eventhandler while one is already set is an error.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{SchedParams}{\optional{doint\, evtmask\, besocial\, \begin{funcdesc}{SchedParams}{\optional{doint, evtmask, besocial, interval, bgyield}}
interval\, bgyield}}
Influence the interpreter inner loop event handling. \var{Interval} Influence the interpreter inner loop event handling. \var{Interval}
specifies how often (in seconds, floating point) the interpreter specifies how often (in seconds, floating point) the interpreter
should enter the event processing code. When true, \var{doint} causes should enter the event processing code. When true, \var{doint} causes
...@@ -75,7 +74,7 @@ early in initialization without first having to load numerous ...@@ -75,7 +74,7 @@ early in initialization without first having to load numerous
extension modules. extension modules.
\end{funcdesc} \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 Drop to the low-level debugger with message \var{message}. The
optional \var{object} argument is not used, but can easily be optional \var{object} argument is not used, but can easily be
inspected from the debugger. inspected from the debugger.
...@@ -86,7 +85,7 @@ system. It is intended mainly for developers of Python extension ...@@ -86,7 +85,7 @@ system. It is intended mainly for developers of Python extension
modules. modules.
\end{funcdesc} \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 Open the resource fork of a file. Arguments are the same as for the
builtin function \code{open}. The object returned has file-like builtin function \code{open}. The object returned has file-like
semantics, but it is not a python file object, so there may be subtle semantics, but it is not a python file object, so there may be subtle
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment