From cbcd2538f45f27885bde62588f73f570553abfda Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 15 Jul 2024 11:25:40 -0400 Subject: [PATCH 1/3] Clarify 'time zone' in a Specific words section --- documentation/style-guide.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index af5c88860f..fb3b5f02bf 100644 --- 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. + Unicode The name of a character coding system. This is always written capitalized. From 4cc5406b5517dedfa4e764f4eb647e156a622ee5 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 18 Jul 2024 12:53:00 -0400 Subject: [PATCH 2/3] Use a reference that matches the section title --- documentation/style-guide.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index fb3b5f02bf..a0a7ad4ab9 100644 --- a/documentation/style-guide.rst +++ b/documentation/style-guide.rst @@ -54,10 +54,10 @@ 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 in :ref:`glossary` to aid authors in maintaining the +spellings are given in :ref:`specific words` to aid authors in maintaining the consistency of presentation in the Python documentation. -.. _glossary: +.. _specific words: Specific words ============== From ac0e188d1724647ee0091c82d37cd50c03491769 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 18 Jul 2024 12:55:51 -0400 Subject: [PATCH 3/3] mention markup use for timezone --- documentation/style-guide.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index a0a7ad4ab9..8ebcec6633 100644 --- a/documentation/style-guide.rst +++ b/documentation/style-guide.rst @@ -85,9 +85,10 @@ reST 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. + When referring to a Python term like a module, class, or argument spell it + as one word with appropriate markup (for example, ``:mod:`timezone```). + When talking about the real-world concept spell it as two words with no + markup. Unicode The name of a character coding system. This is always written