python / cpython

The Python programming language
https://www.python.org
Other
63.39k stars 30.35k forks source link

imaplib.IMAP4.fetch() is missing documentation for message_set parameter #50674

Closed de00d851-6605-4290-b443-719e2a3e952e closed 15 years ago

de00d851-6605-4290-b443-719e2a3e952e commented 15 years ago
BPO 6425
Nosy @birkenfeld, @ezio-melotti, @Sjord

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields: ```python assignee = 'https://github.com/birkenfeld' closed_at = created_at = labels = ['invalid', 'docs'] title = 'imaplib.IMAP4.fetch() is missing documentation for message_set parameter' updated_at = user = 'https://github.com/Sjord' ``` bugs.python.org fields: ```python activity = actor = 'Sjoerder' assignee = 'georg.brandl' closed = True closed_date = closer = 'ezio.melotti' components = ['Documentation'] creation = creator = 'Sjoerder' dependencies = [] files = [] hgrepos = [] issue_num = 6425 keywords = [] message_count = 3.0 messages = ['90165', '90220', '90255'] nosy_count = 3.0 nosy_names = ['georg.brandl', 'ezio.melotti', 'Sjoerder'] pr_nums = [] priority = 'low' resolution = 'not a bug' stage = 'resolved' status = 'closed' superseder = None type = None url = 'https://bugs.python.org/issue6425' versions = ['Python 2.7'] ```

de00d851-6605-4290-b443-719e2a3e952e commented 15 years ago

The message_set parameter imaplib.IMAP4.fetch(message_set, message_parts) is not a set or list, but a comma-separated string, it seems. This could use some documentation.

ezio-melotti commented 15 years ago

The 4th paragraph in the section IMAP4 Objects 1 specifies that: "The message_set options to commands below is a string specifying one or more messages to be acted upon. It may be a simple message number ('1'), a range of message numbers ('2:4'), or a group of non-contiguous ranges separated by commas ('1:3,6:9'). A range can contain an asterisk to indicate an infinite upper bound ('3:*')."

A link to this paragraph could be added in the methods where message_set is used.

de00d851-6605-4290-b443-719e2a3e952e commented 15 years ago

Thanks, I missed that. I only read the documentation for the methods.