[ python-Bugs-1297059 ] Incorrect return type for search() method

[SourceForge.net]

Bugs item #1297059, was opened at 2005-09-20 17:12
Message generated for change (Comment added) made by nnorwitz
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1297059&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: Python 2.4
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Noah Spurrier (noah)
Assigned to: Nobody/Anonymous (nobody)
Summary: Incorrect return type for search() method

Initial Comment:

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



----------------------------------------------------------------------

>Comment By: Neal Norwitz (nnorwitz)
Date: 2005-09-22 21:28

Message:
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

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1297059&group_id=5470