➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Incorrect return type for search() method
Type: Stage:
Components: Documentation Versions: Python 2.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: nnorwitz, noah
Priority: normal Keywords:

Created on 2005-09-21 00:12 by noah, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg26343 - (view) Author: Noah Spurrier (noah) Date: 2005-09-21 00:12 
The documentation for search() method of the IMAP4
object says 
that it returns a string, but it actually returns a tuple.
>>> print imaplib.IMAP4.search.__doc__
Search mailbox for matching messages.

        (typ, [data]) = <instance>.search(charset,
criterion, ...)

        'data' is space separated list of matching
message numbers.

Error can be seen in docs on page:
        http://docs.python.org/lib/imap4-objects.html

Yours,
Noah
msg26344 - (view) Author: Neal Norwitz (nnorwitz) * (Python committer) Date: 2005-09-23 04:28 
Logged In: YES 
user_id=33168

Thanks.  I removed the sentance about returned data since
there is a description of all return values at the top of
the doc.  I also corrected the examples.

Checked in as:
 * Doc/lib/libimaplib.tex 1.34 and 1.30.4.3
History
Date User Action Args
2022-04-11 14:56:13adminsetgithub: 42393
2005-09-21 00:12:50noahcreate