summaryrefslogtreecommitdiffstats
path: root/Doc/library/email.utils.rst
diff options
context:
space:
mode:
authorAlan Williams <astropiloto@gmail.com>2023-03-20 00:20:20 (GMT)
committerGitHub <noreply@github.com>2023-03-20 00:20:20 (GMT)
commit5e6661bce968173fa45b74fa2111098645ff609c (patch)
tree15d81c86c066a70b5907be76d07d1b5d7ba62b44 /Doc/library/email.utils.rst
parent40d4f1579382a16d95ec67f2f03167bc1181dbd9 (diff)
downloadcpython-5e6661bce968173fa45b74fa2111098645ff609c.zip
cpython-5e6661bce968173fa45b74fa2111098645ff609c.tar.gz
cpython-5e6661bce968173fa45b74fa2111098645ff609c.tar.bz2
gh-72346: Added isdst deprecation warning to email.utils.localtime (GH-91450)
Diffstat (limited to 'Doc/library/email.utils.rst')
-rw-r--r--Doc/library/email.utils.rst22
1 files changed, 10 insertions, 12 deletions
diff --git a/Doc/library/email.utils.rst b/Doc/library/email.utils.rst
index 0e266b6..345b640 100644
--- a/Doc/library/email.utils.rst
+++ b/Doc/library/email.utils.rst
@@ -13,19 +13,17 @@ module:
.. function:: localtime(dt=None)
- Return local time as an aware datetime object. If called without
- arguments, return current time. Otherwise *dt* argument should be a
- :class:`~datetime.datetime` instance, and it is converted to the local time
- zone according to the system time zone database. If *dt* is naive (that
- is, ``dt.tzinfo`` is ``None``), it is assumed to be in local time. In this
- case, a positive or zero value for *isdst* causes ``localtime`` to presume
- initially that summer time (for example, Daylight Saving Time) is or is not
- (respectively) in effect for the specified time. A negative value for
- *isdst* causes the ``localtime`` to attempt to divine whether summer time
- is in effect for the specified time.
-
- .. versionadded:: 3.3
+ Return local time as an aware datetime object. If called without
+ arguments, return current time. Otherwise *dt* argument should be a
+ :class:`~datetime.datetime` instance, and it is converted to the local time
+ zone according to the system time zone database. If *dt* is naive (that
+ is, ``dt.tzinfo`` is ``None``), it is assumed to be in local time. The
+ *isdst* parameter is ignored.
+ .. versionadded:: 3.3
+
+ .. deprecated-removed:: 3.12 3.14
+ The *isdst* parameter.
.. function:: make_msgid(idstring=None, domain=None)