From b3c27c6623d4ec20ab6ba8d211236d1d3db798b4 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Fri, 15 Aug 2025 12:08:08 +0300 Subject: [PATCH 1/2] Add boolean to the style guide --- documentation/style-guide.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index 49bd15b1d..ded066104 100644 --- a/documentation/style-guide.rst +++ b/documentation/style-guide.rst @@ -66,6 +66,10 @@ Specific words Some terms and words deserve special mention. These conventions should be used to ensure consistency throughout the documentation: +boolean + Lowercase in most cases. + Uppercase for Boolean mathematics and Boolean logic. + C API Python's `API `_ used by C programmers to write extension modules. All caps and unhyphenated. From b78542a33257ce68b12b93c229fb8d566ceac75d Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Sun, 17 Aug 2025 20:43:56 +0300 Subject: [PATCH 2/2] Improve wording Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- documentation/style-guide.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index ded066104..68350c401 100644 --- a/documentation/style-guide.rst +++ b/documentation/style-guide.rst @@ -67,8 +67,10 @@ Some terms and words deserve special mention. These conventions should be used to ensure consistency throughout the documentation: boolean - Lowercase in most cases. - Uppercase for Boolean mathematics and Boolean logic. + Lowercase in most instances. + Uppercase for *Boolean mathematics* and *Boolean logic*. + To refer to the Python or C data type, prefer using the exact, + abbreviated name with appropriate markup (for example, ``:type:`bool```). C API Python's `API `_ used by C programmers