[Python-checkins] r54243 - in python/trunk: Doc/lib/emailutil.tex Doc/lib/librfc822.tex Misc/NEWS

[collin.winter]

Author: collin.winter
Date: Fri Mar  9 19:09:10 2007
New Revision: 54243

Modified:
   python/trunk/Doc/lib/emailutil.tex
   python/trunk/Doc/lib/librfc822.tex
   python/trunk/Misc/NEWS
Log:
Bug #1629566: clarify the docs on the return values of parsedate() and parsedate_tz() in email.utils and rfc822.


Modified: python/trunk/Doc/lib/emailutil.tex
==============================================================================
--- python/trunk/Doc/lib/emailutil.tex	(original)
+++ python/trunk/Doc/lib/emailutil.tex	Fri Mar  9 19:09:10 2007
@@ -56,7 +56,7 @@
 \code{"Mon, 20 Nov 1995 19:12:08 -0500"}.  If it succeeds in parsing
 the date, \function{parsedate()} returns a 9-tuple that can be passed
 directly to \function{time.mktime()}; otherwise \code{None} will be
-returned.  Note that fields 6, 7, and 8 of the result tuple are not
+returned.  Note that indexes 6, 7, and 8 of the result tuple are not
 usable.
 \end{funcdesc}
 
@@ -70,7 +70,7 @@
 variable for the same timezone; the latter variable follows the
 \POSIX{} standard while this module follows \rfc{2822}.}.  If the input
 string has no timezone, the last element of the tuple returned is
-\code{None}.  Note that fields 6, 7, and 8 of the result tuple are not
+\code{None}.  Note that indexes 6, 7, and 8 of the result tuple are not
 usable.
 \end{funcdesc}
 

Modified: python/trunk/Doc/lib/librfc822.tex
==============================================================================
--- python/trunk/Doc/lib/librfc822.tex	(original)
+++ python/trunk/Doc/lib/librfc822.tex	Fri Mar  9 19:09:10 2007
@@ -100,7 +100,7 @@
 \code{'Mon, 20 Nov 1995 19:12:08 -0500'}.  If it succeeds in parsing
 the date, \function{parsedate()} returns a 9-tuple that can be passed
 directly to \function{time.mktime()}; otherwise \code{None} will be
-returned.  Note that fields 6, 7, and 8 of the result tuple are not
+returned.  Note that indexes 6, 7, and 8 of the result tuple are not
 usable.
 \end{funcdesc}
 
@@ -114,7 +114,7 @@
 variable for the same timezone; the latter variable follows the
 \POSIX{} standard while this module follows \rfc{2822}.)  If the input
 string has no timezone, the last element of the tuple returned is
-\code{None}.  Note that fields 6, 7, and 8 of the result tuple are not
+\code{None}.  Note that indexes 6, 7, and 8 of the result tuple are not
 usable.
 \end{funcdesc}
 

Modified: python/trunk/Misc/NEWS
==============================================================================
--- python/trunk/Misc/NEWS	(original)
+++ python/trunk/Misc/NEWS	Fri Mar  9 19:09:10 2007
@@ -559,6 +559,9 @@
 Documentation
 -------------
 
+- Bug #1629566: clarify the docs on the return values of parsedate()
+  and parsedate_tz() in email.utils and rfc822.
+
 - Patch #1671450: add a section about subclassing builtin types to the
   "extending and embedding" tutorial.