[ python-Bugs-1629566 ] documentation of email.utils.parsedate is confusing

[SourceForge.net]

Bugs item #1629566, was opened at 2007-01-06 16:37
Message generated for change (Comment added) made by collinwinter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1629566&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.5
>Status: Closed
>Resolution: Fixed
Priority: 5
Private: No
Submitted By: Nicholas Riley (nriley)
Assigned to: Collin Winter (collinwinter)
Summary: documentation of email.utils.parsedate is confusing

Initial Comment:
This sentence in the documentation for email.utils.parsedate confused me:

"Note that fields 6, 7, and 8 of the result tuple are not usable."

These indices are zero-based, so it's actually fields 7, 8 and 9 that they are talking about (in normal English).  Either this should be changed to 7-9 or be re-expressed in a way that makes it clear it's zero-based, for example by using Python indexing notation.

Thanks.

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

>Comment By: Collin Winter (collinwinter)
Date: 2007-03-09 13:13

Message:
Logged In: YES 
user_id=1344176
Originator: NO

Fixed in r54243. I changed the ambiguous word "fields" to "indexes", which
should make it perfectly clear where the count starts from.

Thanks for the bug report!

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

Comment By: Mark Roberts (mark-roberts)
Date: 2007-01-19 20:16

Message:
Logged In: YES 
user_id=1591633
Originator: NO

Link to document in question:
http://www.python.org/doc/lib/module-email.utils.html

www.python.org/sf/1639973 for doc patch

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

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