[Python-checkins] python/dist/src/Doc/lib libimaplib.tex, 1.30.4.2, 1.30.4.3
nnorwitz@users.sourceforge.net
nnorwitz at users.sourceforge.net
Fri Sep 23 06:28:27 CEST 2005
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29068/Doc/lib
Modified Files:
Tag: release24-maint
libimaplib.tex
Log Message:
Backport 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.)
Index: libimaplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libimaplib.tex,v
retrieving revision 1.30.4.2
retrieving revision 1.30.4.3
diff -u -d -r1.30.4.2 -r1.30.4.3
--- libimaplib.tex 19 Jan 2005 04:47:50 -0000 1.30.4.2
+++ libimaplib.tex 23 Sep 2005 04:28:23 -0000 1.30.4.3
@@ -322,8 +322,7 @@
\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 @@
\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}
More information about the Python-checkins
mailing list