summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-03-14 06:48:33 (GMT)
committerFred Drake <fdrake@acm.org>1998-03-14 06:48:33 (GMT)
commit2e495c93b0212f4057f3e42a4c2bfdf3729f3f60 (patch)
treecdfcdaacfc89b9f8b3d2b28dacd8bd19349b8f84 /Doc
parentbe2b6d7f42b05331c6c3087749026a42000ad3c9 (diff)
downloadcpython-2e495c93b0212f4057f3e42a4c2bfdf3729f3f60.zip
cpython-2e495c93b0212f4057f3e42a4c2bfdf3729f3f60.tar.gz
cpython-2e495c93b0212f4057f3e42a4c2bfdf3729f3f60.tar.bz2
Logical markup, using {classdesc} as appropriate.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libmailbox.tex18
-rw-r--r--Doc/libmailbox.tex18
2 files changed, 18 insertions, 18 deletions
diff --git a/Doc/lib/libmailbox.tex b/Doc/lib/libmailbox.tex
index 7adcf62..3261217 100644
--- a/Doc/lib/libmailbox.tex
+++ b/Doc/lib/libmailbox.tex
@@ -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
diff --git a/Doc/libmailbox.tex b/Doc/libmailbox.tex
index 7adcf62..3261217 100644
--- a/Doc/libmailbox.tex
+++ b/Doc/libmailbox.tex
@@ -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