mirror of
https://github.com/python/cpython.git
synced 2025-11-26 21:33:10 +00:00
Use methoddesc instead of funcdesc to describe the only method.
This commit is contained in:
parent
2351c80747
commit
182bd2d176
2 changed files with 4 additions and 4 deletions
|
|
@ -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}.
|
||||||
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}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue