mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-11-25 19:03:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

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.)

Browse Source
This commit is contained in:
Neal Norwitz 2005-09-23 04:26:24 +00:00
parent 5a13e91f72
commit 02cfa0bae5
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Doc/lib/libimaplib.tex
View File

@ -327,8 +327,7 @@ data = authobject(response)
\end{methoddesc}
\begin{methoddesc}{search}{charset, criterion\optional{, ...}}
Search mailbox for matching messages. Returned data contains a space
separated list of matching message numbers. \var{charset} may be
Search mailbox for matching messages. \var{charset} may be
\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
criterion be specified; an exception will be raised when the server
@ -338,10 +337,10 @@ data = authobject(response)
\begin{verbatim}
# M is a connected IMAP4 instance...
msgnums = M.search(None, 'FROM', '"LDJ"')
typ, msgnums = M.search(None, 'FROM', '"LDJ"')
# or:
msgnums = M.search(None, '(FROM "LDJ")')
typ, msgnums = M.search(None, '(FROM "LDJ")')
\end{verbatim}
\end{methoddesc}