[Python-checkins] [3.8] bpo-38421: Update email.utils documentation (GH-16678) (GH-17122)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/29fd6a77d509cffacc5691ebd9dab53455ad959e
commit: 29fd6a77d509cffacc5691ebd9dab53455ad959e
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-11-12T05:34:23-08:00
summary:

[3.8] bpo-38421: Update email.utils documentation (GH-16678) (GH-17122)



Updates documentation around email.utils.parsedate_tz().

Currently, the documentation specifies that when a string without a is timezone passed to parsedate_tz(), the last tuple is returned as ```None```.

This is no longer true since Python 3.3


https://bugs.python.org/issue38421
(cherry picked from commit a12255d8def0c82560545e66c1be981a447751c3)


Co-authored-by: David K <dave at paddez.com>


https://bugs.python.org/issue38421



Automerge-Triggered-By: @encukou

files:
M Doc/library/email.utils.rst

diff --git a/Doc/library/email.utils.rst b/Doc/library/email.utils.rst
index 63fae2ab84e21..4d0e920eb0ad2 100644
--- a/Doc/library/email.utils.rst
+++ b/Doc/library/email.utils.rst
@@ -117,8 +117,8 @@ of the new API.
    a 10-tuple; the first 9 elements make up a tuple that can be passed directly to
    :func:`time.mktime`, and the tenth is the offset of the date's timezone from UTC
    (which is the official term for Greenwich Mean Time) [#]_.  If the input string
-   has no timezone, the last element of the tuple returned is ``None``.  Note that
-   indexes 6, 7, and 8 of the result tuple are not usable.
+   has no timezone, the last element of the tuple returned is ``0``, which represents
+   UTC. Note that indexes 6, 7, and 8 of the result tuple are not usable.
 
 
 .. function:: parsedate_to_datetime(date)