Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 3a4ceb7

Browse files
committed
Several methods return tuples, not lists.
1 parent 363d67c commit 3a4ceb7

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

Doc/lib/libpoplib.tex

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,13 @@ \subsection{POP3 Objects \label{pop3-objects}}
7070

7171
\begin{methoddesc}{list}{\optional{which}}
7272
Request message list, result is in the form
73-
\code{['response', ['mesg_num octets', ...]]}. If \var{which} is
73+
\code{(\var{response}, ['mesg_num octets', ...])}. If \var{which} is
7474
set, it is the message to list.
7575
\end{methoddesc}
7676

7777
\begin{methoddesc}{retr}{which}
7878
Retrieve whole message number \var{which}. Result is in form
79-
\code{['response', ['line', ...], octets]}.
79+
\code{(\var{response}, ['line', ...], \var{octets})}.
8080
\end{methoddesc}
8181

8282
\begin{methoddesc}{dele}{which}
@@ -98,14 +98,15 @@ \subsection{POP3 Objects \label{pop3-objects}}
9898
\begin{methoddesc}{top}{which, howmuch}
9999
Retrieves the message header plus \var{howmuch} lines of the message
100100
after the header of message number \var{which}. Result is in form
101-
\code{['response', ['line', ...], octets]}.
101+
\code{(\var{response}, ['line', ...], \var{octets})}.
102102
\end{methoddesc}
103103

104104
\begin{methoddesc}{uidl}{\optional{which}}
105105
Return message digest (unique id) list.
106106
If \var{which} is specified, result contains the unique id for that
107107
message in the form \code{'\var{response}\ \var{mesgnum}\ \var{uid}},
108-
otherwise result is list \code{['response', ['mesgnum uid', ...], octets]}.
108+
otherwise result is list \code{(\var{response}, ['mesgnum uid', ...],
109+
\var{octets})}.
109110
\end{methoddesc}
110111

111112

0 commit comments

Comments
 (0)