Commit 02cfa0ba authored by Neal Norwitz's avatar Neal Norwitz

SF #1297059, doc incorrect return type for search() method. (There is a...

SF #1297059, doc incorrect return type for search() method.  (There is a description of returned values at the top, so just remove the sentance and correct an example.)
parent 5a13e91f
...@@ -327,8 +327,7 @@ data = authobject(response) ...@@ -327,8 +327,7 @@ data = authobject(response)
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{search}{charset, criterion\optional{, ...}} \begin{methoddesc}{search}{charset, criterion\optional{, ...}}
Search mailbox for matching messages. Returned data contains a space Search mailbox for matching messages. \var{charset} may be
separated list of matching message numbers. \var{charset} may be
\code{None}, in which case no \samp{CHARSET} will be specified in the \code{None}, in which case no \samp{CHARSET} will be specified in the
request to the server. The IMAP protocol requires that at least one request to the server. The IMAP protocol requires that at least one
criterion be specified; an exception will be raised when the server criterion be specified; an exception will be raised when the server
...@@ -338,10 +337,10 @@ data = authobject(response) ...@@ -338,10 +337,10 @@ data = authobject(response)
\begin{verbatim} \begin{verbatim}
# M is a connected IMAP4 instance... # M is a connected IMAP4 instance...
msgnums = M.search(None, 'FROM', '"LDJ"') typ, msgnums = M.search(None, 'FROM', '"LDJ"')
# or: # or:
msgnums = M.search(None, '(FROM "LDJ")') typ, msgnums = M.search(None, '(FROM "LDJ")')
\end{verbatim} \end{verbatim}
\end{methoddesc} \end{methoddesc}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment