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

This commit is contained in:
Collin Winter 2007-03-09 18:09:10 +00:00
parent 1190a38d33
commit b7b2b4eecf
3 changed files with 7 additions and 4 deletions

View File

@ -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}

View File

@ -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}

View File

@ -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.