summaryrefslogtreecommitdiffstats
path: root/Doc/libmacic.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1997-12-29 18:53:31 (GMT)
committerFred Drake <fdrake@acm.org>1997-12-29 18:53:31 (GMT)
commit671fe9dd3129129b8be53cede504b7dc772e58a1 (patch)
tree329c3d0b30395b735a93a2e78065024b5c4f4f5d /Doc/libmacic.tex
parenta3e672b574e6b4c5732346a8bed8bbc26140da42 (diff)
downloadcpython-671fe9dd3129129b8be53cede504b7dc772e58a1.zip
cpython-671fe9dd3129129b8be53cede504b7dc772e58a1.tar.gz
cpython-671fe9dd3129129b8be53cede504b7dc772e58a1.tar.bz2
Reduce warning count from partparse.py.
Diffstat (limited to 'Doc/libmacic.tex')
-rw-r--r--Doc/libmacic.tex23
1 files changed, 11 insertions, 12 deletions
diff --git a/Doc/libmacic.tex b/Doc/libmacic.tex
index fd16002..d797cfa 100644
--- a/Doc/libmacic.tex
+++ b/Doc/libmacic.tex
@@ -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