]> granicus.if.org Git - python/commitdiff
Use methoddesc instead of funcdesc to describe the only method.
authorFred Drake <fdrake@acm.org>
Thu, 2 Apr 1998 18:50:21 +0000 (18:50 +0000)
committerFred Drake <fdrake@acm.org>
Thu, 2 Apr 1998 18:50:21 +0000 (18:50 +0000)
Doc/lib/libmailbox.tex
Doc/libmailbox.tex

index 32612172000b0c7f20e06e726b775f1ad65e6076..e9dcb896de25d30ecbce5eba400a03d944c4d3ba 100644 (file)
@@ -30,10 +30,10 @@ The name of the mailbox directory is passed in \var{dirname}.
 All implementations of Mailbox objects have one externally visible
 method:
 
-\begin{funcdesc}{next}{}
+\begin{methoddesc}[mailbox]{next}{}
 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
 contained in a single file, etc.
-\end{funcdesc}
+\end{methoddesc}
index 32612172000b0c7f20e06e726b775f1ad65e6076..e9dcb896de25d30ecbce5eba400a03d944c4d3ba 100644 (file)
@@ -30,10 +30,10 @@ The name of the mailbox directory is passed in \var{dirname}.
 All implementations of Mailbox objects have one externally visible
 method:
 
-\begin{funcdesc}{next}{}
+\begin{methoddesc}[mailbox]{next}{}
 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
 contained in a single file, etc.
-\end{funcdesc}
+\end{methoddesc}