[Python-checkins] bpo-20281, bpo-29964: update datetime docs to refer %z and %Z to a pre-existing footnote (GH-30354)
brettcannon
webhook-mailer at python.org
Fri Jan 14 17:49:24 EST 2022
https://github.com/python/cpython/commit/305588c67cdede4ef127ada90c1557bc1ef7c200
commit: 305588c67cdede4ef127ada90c1557bc1ef7c200
branch: main
author: Hugo van Kemenade <hugovk at users.noreply.github.com>
committer: brettcannon <brett at python.org>
date: 2022-01-14T14:49:12-08:00
summary:
bpo-20281, bpo-29964: update datetime docs to refer %z and %Z to a pre-existing footnote (GH-30354)
files:
M Doc/library/time.rst
diff --git a/Doc/library/time.rst b/Doc/library/time.rst
index 622f66719cee7..6540932eecbaa 100644
--- a/Doc/library/time.rst
+++ b/Doc/library/time.rst
@@ -476,10 +476,10 @@ Functions
| | negative time difference from UTC/GMT of the | |
| | form +HHMM or -HHMM, where H represents decimal| |
| | hour digits and M represents decimal minute | |
- | | digits [-23:59, +23:59]. | |
+ | | digits [-23:59, +23:59]. [1]_ | |
+-----------+------------------------------------------------+-------+
| ``%Z`` | Time zone name (no characters if no time zone | |
- | | exists). | |
+ | | exists). Deprecated. [1]_ | |
+-----------+------------------------------------------------+-------+
| ``%%`` | A literal ``'%'`` character. | |
+-----------+------------------------------------------------+-------+
@@ -500,7 +500,7 @@ Functions
calculations when the day of the week and the year are specified.
Here is an example, a format for dates compatible with that specified in the
- :rfc:`2822` Internet email standard. [#]_ ::
+ :rfc:`2822` Internet email standard. [1]_ ::
>>> from time import gmtime, strftime
>>> strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime())
@@ -928,10 +928,9 @@ Timezone Constants
.. rubric:: Footnotes
-.. [#] The use of ``%Z`` is now deprecated, but the ``%z`` escape that expands to the
- preferred hour/minute offset is not supported by all ANSI C libraries. Also, a
+.. [1] The use of ``%Z`` is now deprecated, but the ``%z`` escape that expands to the
+ preferred hour/minute offset is not supported by all ANSI C libraries. Also, a
strict reading of the original 1982 :rfc:`822` standard calls for a two-digit
- year (%y rather than %Y), but practice moved to 4-digit years long before the
+ year (``%y`` rather than ``%Y``), but practice moved to 4-digit years long before the
year 2000. After that, :rfc:`822` became obsolete and the 4-digit year has
been first recommended by :rfc:`1123` and then mandated by :rfc:`2822`.
-
More information about the Python-checkins
mailing list