]> granicus.if.org Git - python/commitdiff
Logical markup, using {classdesc} as appropriate.
authorFred Drake <fdrake@acm.org>
Sat, 14 Mar 1998 06:48:33 +0000 (06:48 +0000)
committerFred Drake <fdrake@acm.org>
Sat, 14 Mar 1998 06:48:33 +0000 (06:48 +0000)
Doc/lib/libmailbox.tex
Doc/libmailbox.tex

index 7adcf62a040e45716f70df7c448fe6645e1308b6..32612172000b0c7f20e06e726b775f1ad65e6076 100644 (file)
@@ -2,36 +2,36 @@
 \label{module-mailbox}
 \stmodindex{mailbox}
 
-\setindexsubitem{(in module mailbox)}
 
 This module defines a number of classes that allow easy and uniform
-access to mail messages in a (unix) mailbox.
+access to mail messages in a (\UNIX{}) mailbox.
 
-\begin{funcdesc}{UnixMailbox}{fp}
+\begin{classdesc}{UnixMailbox}{fp}
 Access a classic \UNIX{}-style mailbox, where all messages are contained
 in a single file and separated by ``From name time'' lines.
 The file object \var{fp} points to the mailbox file.
-\end{funcdesc}
+\end{classdesc}
 
-\begin{funcdesc}{MmdfMailbox}{fp}
+\begin{classdesc}{MmdfMailbox}{fp}
 Access an MMDF-style mailbox, where all messages are contained
 in a single file and separated by lines consisting of 4 control-A
 characters.  The file object \var{fp} points to the mailbox file.
-\end{funcdesc}
+\end{classdesc}
 
-\begin{funcdesc}{MHMailbox}{dirname}
+\begin{classdesc}{MHMailbox}{dirname}
 Access an MH mailbox, a directory with each message in a separate
 file with a numeric name.
 The name of the mailbox directory is passed in \var{dirname}.
-\end{funcdesc}
+\end{classdesc}
 
 \subsection{Mailbox Objects}
+\label{mailbox-objects}
 
 All implementations of Mailbox objects have one externally visible
 method:
 
 \begin{funcdesc}{next}{}
-Return the next message in the mailbox, as a \code{rfc822.Message} object.
+Return the next message in the mailbox, as a \class{rfc822.Message} object.
 Depending on the mailbox implementation the \var{fp} attribute of this
 object may be a true file object or a class instance simulating a file object,
 taking care of things like message boundaries if multiple mail messages are
index 7adcf62a040e45716f70df7c448fe6645e1308b6..32612172000b0c7f20e06e726b775f1ad65e6076 100644 (file)
@@ -2,36 +2,36 @@
 \label{module-mailbox}
 \stmodindex{mailbox}
 
-\setindexsubitem{(in module mailbox)}
 
 This module defines a number of classes that allow easy and uniform
-access to mail messages in a (unix) mailbox.
+access to mail messages in a (\UNIX{}) mailbox.
 
-\begin{funcdesc}{UnixMailbox}{fp}
+\begin{classdesc}{UnixMailbox}{fp}
 Access a classic \UNIX{}-style mailbox, where all messages are contained
 in a single file and separated by ``From name time'' lines.
 The file object \var{fp} points to the mailbox file.
-\end{funcdesc}
+\end{classdesc}
 
-\begin{funcdesc}{MmdfMailbox}{fp}
+\begin{classdesc}{MmdfMailbox}{fp}
 Access an MMDF-style mailbox, where all messages are contained
 in a single file and separated by lines consisting of 4 control-A
 characters.  The file object \var{fp} points to the mailbox file.
-\end{funcdesc}
+\end{classdesc}
 
-\begin{funcdesc}{MHMailbox}{dirname}
+\begin{classdesc}{MHMailbox}{dirname}
 Access an MH mailbox, a directory with each message in a separate
 file with a numeric name.
 The name of the mailbox directory is passed in \var{dirname}.
-\end{funcdesc}
+\end{classdesc}
 
 \subsection{Mailbox Objects}
+\label{mailbox-objects}
 
 All implementations of Mailbox objects have one externally visible
 method:
 
 \begin{funcdesc}{next}{}
-Return the next message in the mailbox, as a \code{rfc822.Message} object.
+Return the next message in the mailbox, as a \class{rfc822.Message} object.
 Depending on the mailbox implementation the \var{fp} attribute of this
 object may be a true file object or a class instance simulating a file object,
 taking care of things like message boundaries if multiple mail messages are