mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#18243: Remove obsolete cautionary note from email mktime_tz docs.

This commit is contained in:
R David Murray 2014-04-26 19:01:18 -04:00
parent e3083d3ad5
commit ae25f46706
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/email.util.rst
View File

@ -98,12 +98,9 @@ There are several useful utilities provided in the :mod:`email.utils` module:
.. function:: mktime_tz(tuple)
Turn a 10-tuple as returned by :func:`parsedate_tz` into a UTC timestamp. It
the timezone item in the tuple is ``None``, assume local time. Minor
deficiency: :func:`mktime_tz` interprets the first 8 elements of *tuple* as a
local time and then compensates for the timezone difference. This may yield a
slight error around changes in daylight savings time, though not worth worrying
about for common use.
Turn a 10-tuple as returned by :func:`parsedate_tz` into a UTC
timestamp (seconds since the Epoch). If the timezone item in the
tuple is ``None``, assume local time.
.. function:: formatdate(timeval=None, localtime=False, usegmt=False)
@ -210,4 +207,3 @@ There are several useful utilities provided in the :mod:`email.utils` module:
.. [#] Note that the sign of the timezone offset is the opposite of the sign of the
``time.timezone`` variable for the same timezone; the latter variable follows
the POSIX standard while this module follows :rfc:`2822`.