]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Several methods return tuples, not lists.
authorFred Drake <fdrake@acm.org>
Wed, 7 Jul 1999 14:04:38 +0000 (14:04 +0000)
committerFred Drake <fdrake@acm.org>
Wed, 7 Jul 1999 14:04:38 +0000 (14:04 +0000)
Doc/lib/libpoplib.tex

index 14f38dff21c5c321cb87282211c3001bee13c316..fc73a31b059cbf27f8a81ad10c20ccdcaa880a8f 100644 (file)
@@ -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}