]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Backport SF #1297059, doc incorrect return type for search() method. (There is a...
authorNeal Norwitz <nnorwitz@gmail.com>
Fri, 23 Sep 2005 04:28:23 +0000 (04:28 +0000)
committerNeal Norwitz <nnorwitz@gmail.com>
Fri, 23 Sep 2005 04:28:23 +0000 (04:28 +0000)
Doc/lib/libimaplib.tex

index 3448ba6925d1b0cbd334cd3f38a97ead3b247f7e..d150629ec98a94447cb5d18d35ae4cc0a18d62c4 100644 (file)
@@ -322,8 +322,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
@@ -333,10 +332,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}