summaryrefslogtreecommitdiffstats
path: root/Doc/library/email.util.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-04-26 23:01:18 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-04-26 23:01:18 (GMT)
commitae25f46706659575c91d579ebcae02584e624ad9 (patch)
treef6a0e5ce3d67c7d12cbbfb26297054994af206d9 /Doc/library/email.util.rst
parente3083d3ad541432e2420869c7ed56fb9aff7a453 (diff)
downloadcpython-ae25f46706659575c91d579ebcae02584e624ad9.zip
cpython-ae25f46706659575c91d579ebcae02584e624ad9.tar.gz
cpython-ae25f46706659575c91d579ebcae02584e624ad9.tar.bz2
#18243: Remove obsolete cautionary note from email mktime_tz docs.
Diffstat (limited to 'Doc/library/email.util.rst')
-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`.
-