Commit 04ae3521 authored by Fred Drake's avatar Fred Drake

Minor logical markup nits.

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