summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-04-26 23:05:03 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-04-26 23:05:03 (GMT)
commit9b244ad12d72af666586eeddde30e30e5ff0035a (patch)
tree2621fbc3dca7ff79c59d7d804eae0e1a8d47d638
parent32ae4378b945b55d482539f83fdd0aeac8b6f375 (diff)
downloadcpython-9b244ad12d72af666586eeddde30e30e5ff0035a.zip
cpython-9b244ad12d72af666586eeddde30e30e5ff0035a.tar.gz
cpython-9b244ad12d72af666586eeddde30e30e5ff0035a.tar.bz2
#18243: Remove obsolete cautionary note from email mktime_tz docs.
-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 26f1919..9b583c0 100644
--- a/Doc/library/email.util.rst
+++ b/Doc/library/email.util.rst
@@ -76,12 +76,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[, localtime][, usegmt]])
@@ -165,4 +162,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`.
-