Bug #1629566: clarify the docs on the return values of parsedate() and parsedate_tz...

diff --git a/Doc/lib/emailutil.tex b/Doc/lib/emailutil.tex
index fe96473638fad97afc2206969612b86ffddac4bc..f9fe2d467cb8001b21fc25125219013d28723a58 100644 (file)
--- a/Doc/lib/emailutil.tex
+++ b/Doc/lib/emailutil.tex
@@ -56,7 +56,7 @@ however, some mailers don't follow that format as specified, so
 \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 @@ offset is the opposite of the sign of the \code{time.timezone}
 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}
 

diff --git a/Doc/lib/librfc822.tex b/Doc/lib/librfc822.tex
index 4ca3734db59034786071d800d276fb23d50abac9..f0030752d1c1b63569950296d00ccaf8848e45c2 100644 (file)
--- a/Doc/lib/librfc822.tex
+++ b/Doc/lib/librfc822.tex
@@ -100,7 +100,7 @@ however, some mailers don't follow that format as specified, so
 \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 @@ offset is the opposite of the sign of the \code{time.timezone}
 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}
 

diff --git a/Misc/NEWS b/Misc/NEWS
index 635b2c40e52d217a5c5426ce1d23166d5b92afcc..d3bb47d1d1a6d1f6bf1147c940243c95a71b5e5d 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -559,6 +559,9 @@ Tools
 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.