[Python-checkins] cpython (merge 3.4 -> default): Merge: #18243: Remove obsolete cautionary note from email mktime_tz docs.

[r.david.murray]

http://hg.python.org/cpython/rev/462470859e57
changeset:   90470:462470859e57
parent:      90468:dbceba88b96e
parent:      90469:d24f1fb256a3
user:        R David Murray <rdmurray at bitdance.com>
date:        Sat Apr 26 19:01:47 2014 -0400
summary:
  Merge: #18243: Remove obsolete cautionary note from email mktime_tz docs.

files:
  Doc/library/email.util.rst |  10 +++-------
  1 files changed, 3 insertions(+), 7 deletions(-)


diff --git a/Doc/library/email.util.rst b/Doc/library/email.util.rst
--- a/Doc/library/email.util.rst
+++ b/Doc/library/email.util.rst
@@ -98,12 +98,9 @@
 
 .. 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 @@
 .. [#] 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`.
-

-- 
Repository URL: http://hg.python.org/cpython