]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Minor logical markup nits.
authorFred Drake <fdrake@acm.org>
Thu, 22 Apr 1999 16:46:18 +0000 (16:46 +0000)
committerFred Drake <fdrake@acm.org>
Thu, 22 Apr 1999 16:46:18 +0000 (16:46 +0000)
Make some module references hyperlinks.

Doc/lib/libimaplib.tex

index 14daf41cfff5c6588a2b67bd0d56367f04c52de9..294963fe1ed1fc274c45986cf49187ae5a92351b 100644 (file)
@@ -2,13 +2,13 @@
 % converted by Fred L. Drake, Jr. <fdrake@acm.org>.
 
 \section{\module{imaplib} ---
-         IMAP4 protocol client.}
+         IMAP4 protocol client}
+
 \declaremodule{standard}{imaplib}
+\modulesynopsis{IMAP4 protocol client (requires sockets).}
 \moduleauthor{Piers Lauder}{piers@staff.cs.usyd.edu.au}
 \sectionauthor{Piers Lauder}{piers@staff.cs.usyd.edu.au}
 
-\modulesynopsis{IMAP4 protocol client (requires sockets).}
-
 \indexii{IMAP4}{protocol}
 
 This module defines a class, \class{IMAP4}, which encapsulates a
@@ -17,7 +17,7 @@ protocol as defined in \rfc{2060}. It is backward compatible with
 IMAP4 (\rfc{1730}) servers, but note that the \samp{STATUS} command is
 not supported in IMAP4.
 
-A single class is provided by the \code{imaplib} module:
+A single class is provided by the \module{imaplib} module:
 
 \begin{classdesc}{IMAP4}{\optional{host\optional{, port}}}
 This class implements the actual IMAP4 protocol.  The connection is
@@ -45,7 +45,7 @@ The following utility functions are defined:
 
 \begin{funcdesc}{Internaldate2tuple}{datestr}
   Converts an IMAP4 INTERNALDATE string to Coordinated Universal
-  Time. Returns a \module{time} module tuple.
+  Time. Returns a \refmodule{time} module tuple.
 \end{funcdesc}
 
 \begin{funcdesc}{Int2AP}{num}
@@ -59,7 +59,7 @@ The following utility functions are defined:
 \end{funcdesc}
 
 \begin{funcdesc}{Time2Internaldate}{date_time}
-  Converts a \module{time} module tuple to an IMAP4
+  Converts a \refmodule{time} module tuple to an IMAP4
   \samp{INTERNALDATE} representation.  Returns a string in the form:
   \code{"DD-Mmm-YYYY HH:MM:SS +HHMM"} (including double-quotes).
 \end{funcdesc}
@@ -71,8 +71,8 @@ The following utility functions are defined:
 All IMAP4rev1 commands are represented by methods of the same name,
 either upper-case or lower-case.
 
-Each command returns a tuple: \code{(}\var{type}, \code{[}\var{data},
-...\code{])} where \var{type} is usually \code{'OK'} or \code{'NO'},
+Each command returns a tuple: \code{(\var{type}, [\var{data},
+...])} where \var{type} is usually \code{'OK'} or \code{'NO'},
 and \var{data} is either the text from the command response, or
 mandated results from the command.
 
@@ -201,8 +201,8 @@ The following attributes are defined on instances of \class{IMAP4}:
 
 
 \begin{memberdesc}{PROTOCOL_VERSION}
-The most recent supported protocol in the \samp{CAPABILITY}
-response from the server.
+The most recent supported protocol in the
+\samp{CAPABILITY} response from the server.
 \end{memberdesc}
 
 \begin{memberdesc}{debug}