traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Several methods return tuples, not lists.

This commit is contained in:
Fred Drake 1999-07-07 14:04:38 +00:00
parent 363d67c2e6
commit 3a4ceb707d
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/lib/libpoplib.tex
View File

@ -70,13 +70,13 @@ Get mailbox status. The result is a tuple of 2 integers:
\begin{methoddesc}{list}{\optional{which}} \begin{methoddesc}{list}{\optional{which}}
Request message list, result is in the form Request message list, result is in the form
\code{['response', ['mesg_num octets', ...]]}. If \var{which} is \code{(\var{response}, ['mesg_num octets', ...])}. If \var{which} is
set, it is the message to list. set, it is the message to list.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{retr}{which} \begin{methoddesc}{retr}{which}
Retrieve whole message number \var{which}. Result is in form Retrieve whole message number \var{which}. Result is in form
\code{['response', ['line', ...], octets]}. \code{(\var{response}, ['line', ...], \var{octets})}.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{dele}{which} \begin{methoddesc}{dele}{which}
@ -98,14 +98,15 @@ Signoff: commit changes, unlock mailbox, drop connection.
\begin{methoddesc}{top}{which, howmuch} \begin{methoddesc}{top}{which, howmuch}
Retrieves the message header plus \var{howmuch} lines of the message Retrieves the message header plus \var{howmuch} lines of the message
after the header of message number \var{which}. Result is in form after the header of message number \var{which}. Result is in form
\code{['response', ['line', ...], octets]}. \code{(\var{response}, ['line', ...], \var{octets})}.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{uidl}{\optional{which}} \begin{methoddesc}{uidl}{\optional{which}}
Return message digest (unique id) list. Return message digest (unique id) list.
If \var{which} is specified, result contains the unique id for that If \var{which} is specified, result contains the unique id for that
message in the form \code{'\var{response}\ \var{mesgnum}\ \var{uid}}, message in the form \code{'\var{response}\ \var{mesgnum}\ \var{uid}},
otherwise result is list \code{['response', ['mesgnum uid', ...], octets]}. otherwise result is list \code{(\var{response}, ['mesgnum uid', ...],
\var{octets})}.
\end{methoddesc} \end{methoddesc}