Kaydet (Commit) 182bd2d1 authored tarafından Fred Drake's avatar Fred Drake

Use methoddesc instead of funcdesc to describe the only method.

üst 2351c807
...@@ -30,10 +30,10 @@ The name of the mailbox directory is passed in \var{dirname}. ...@@ -30,10 +30,10 @@ The name of the mailbox directory is passed in \var{dirname}.
All implementations of Mailbox objects have one externally visible All implementations of Mailbox objects have one externally visible
method: method:
\begin{funcdesc}{next}{} \begin{methoddesc}[mailbox]{next}{}
Return the next message in the mailbox, as a \class{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 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, 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 taking care of things like message boundaries if multiple mail messages are
contained in a single file, etc. contained in a single file, etc.
\end{funcdesc} \end{methoddesc}
...@@ -30,10 +30,10 @@ The name of the mailbox directory is passed in \var{dirname}. ...@@ -30,10 +30,10 @@ The name of the mailbox directory is passed in \var{dirname}.
All implementations of Mailbox objects have one externally visible All implementations of Mailbox objects have one externally visible
method: method:
\begin{funcdesc}{next}{} \begin{methoddesc}[mailbox]{next}{}
Return the next message in the mailbox, as a \class{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 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, 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 taking care of things like message boundaries if multiple mail messages are
contained in a single file, etc. contained in a single file, etc.
\end{funcdesc} \end{methoddesc}
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