summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-04-26 23:01:47 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-04-26 23:01:47 (GMT)
commitdd41f246875494c9acc6ebd4338f8df3ec6c28f0 (patch)
tree39a3fb7bf19433b534d267f1e23ee076689ddb45 /Doc
parent4453cf576a18bc98131b7117691a8ea311b348cd (diff)
parentae25f46706659575c91d579ebcae02584e624ad9 (diff)
downloadcpython-dd41f246875494c9acc6ebd4338f8df3ec6c28f0.zip
cpython-dd41f246875494c9acc6ebd4338f8df3ec6c28f0.tar.gz
cpython-dd41f246875494c9acc6ebd4338f8df3ec6c28f0.tar.bz2
Merge: #18243: Remove obsolete cautionary note from email mktime_tz docs.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/email.util.rst10
1 files changed, 3 insertions, 7 deletions
diff --git a/Doc/library/email.util.rst b/Doc/library/email.util.rst
index f75975e..219e284 100644
--- a/Doc/library/email.util.rst
+++ b/Doc/library/email.util.rst
@@ -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`.
-