From b7b2b4eecfb3437f9da065251f1a35bf9c43db20 Mon Sep 17 00:00:00 2001 From: Collin Winter Date: Fri, 9 Mar 2007 18:09:10 +0000 Subject: Bug #1629566: clarify the docs on the return values of parsedate() and parsedate_tz() in email.utils and rfc822. --- Doc/lib/emailutil.tex | 4 ++-- Doc/lib/librfc822.tex | 4 ++-- Misc/NEWS | 3 +++ 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/Doc/lib/emailutil.tex b/Doc/lib/emailutil.tex index fe96473..f9fe2d4 100644 --- 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 4ca3734..f003075 100644 --- 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 635b2c4..d3bb47d 100644 --- 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. -- cgit v0.12