diff options
author | Fred Drake <fdrake@acm.org> | 1999-07-07 14:04:38 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 1999-07-07 14:04:38 (GMT) |
commit | 3a4ceb707d7b9acf41a44cb9a42610a1ef9584c9 (patch) | |
tree | ac4a7fb3e0a3f35e61912aaf46d1e1889ae858cf /Doc/lib/libpoplib.tex | |
parent | 363d67c2e62801cfaca7faec769a18acc4af49c2 (diff) | |
download | cpython-3a4ceb707d7b9acf41a44cb9a42610a1ef9584c9.zip cpython-3a4ceb707d7b9acf41a44cb9a42610a1ef9584c9.tar.gz cpython-3a4ceb707d7b9acf41a44cb9a42610a1ef9584c9.tar.bz2 |
Several methods return tuples, not lists.
Diffstat (limited to 'Doc/lib/libpoplib.tex')
-rw-r--r-- | Doc/lib/libpoplib.tex | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/lib/libpoplib.tex b/Doc/lib/libpoplib.tex index 14f38df..fc73a31 100644 --- a/Doc/lib/libpoplib.tex +++ b/Doc/lib/libpoplib.tex @@ -70,13 +70,13 @@ Get mailbox status. The result is a tuple of 2 integers: \begin{methoddesc}{list}{\optional{which}} 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. \end{methoddesc} \begin{methoddesc}{retr}{which} Retrieve whole message number \var{which}. Result is in form -\code{['response', ['line', ...], octets]}. +\code{(\var{response}, ['line', ...], \var{octets})}. \end{methoddesc} \begin{methoddesc}{dele}{which} @@ -98,14 +98,15 @@ Signoff: commit changes, unlock mailbox, drop connection. \begin{methoddesc}{top}{which, howmuch} Retrieves the message header plus \var{howmuch} lines of the message after the header of message number \var{which}. Result is in form -\code{['response', ['line', ...], octets]}. +\code{(\var{response}, ['line', ...], \var{octets})}. \end{methoddesc} \begin{methoddesc}{uidl}{\optional{which}} Return message digest (unique id) list. If \var{which} is specified, result contains the unique id for that 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} |