Clarify 'time zone' in a Specific words section

python · nedbat · Jul 18, 2024 · Jul 15, 2024 · Jul 18, 2024 · Jul 18, 2024
commit cbcd2538f45f27885bde62588f73f570553abfda
diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst
@@ -54,10 +54,15 @@ starting it with a lowercase letter should be avoided.
 Many special names are used in the Python documentation, including the names of
 operating systems, programming languages, standards bodies, and the like. Most
 of these entities are not assigned any special markup, but the preferred
-spellings are given here to aid authors in maintaining the consistency of
-presentation in the Python documentation.
+spellings are given in :ref:`glossary` to aid authors in maintaining the
+consistency of presentation in the Python documentation.

-Other terms and words deserve special mention as well; these conventions should
+.. _glossary:
+
+Specific words
+==============
+
+Some terms and words deserve special mention. These conventions should
 be used to ensure consistency throughout the documentation:

 C API
@@ -79,6 +84,11 @@ reST
   used to produce Python documentation.  When spelled out, it is
   always one word and both forms start with a lowercase 'r'.

+time zone
+   Spell out as two words when talking about the real-world concept.
+   Only spell as one word when referring to a Python term like a module,
+   class, or argument.
-   Spell out as two words when talking about the real-world concept.
-   Only spell as one word when referring to a Python term like a module,
-   class, or argument.
+   When referring to a Python term like a module, class, or argument
+   it is always spelled as one word and surrounded by the appropriate markup
+   (for example, ``:mod:`timezone```).
+   When talking about the real-world concept it is spelled as two words.
-   Spell out as two words when talking about the real-world concept.
-   Only spell as one word when referring to a Python term like a module,
-   class, or argument.
+   When referring to a Python term like a module, class, or argument
+   it is always spelled as one word and surrounded by the appropriate markup
+   (for example, ``:mod:`timezone```).
+   When talking about the real-world concept it is spelled as two words.
+
 Unicode
   The name of a character coding system. This is always written
   capitalized.