From 34b87d3ba90cfcb78ac0bc89ba50602ebe8e7931 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 23 May 2026 13:15:43 -0400 Subject: [PATCH 1/3] Minor grammar fixes --- developer-workflow/extension-modules.rst | 2 +- developer-workflow/stdlib.rst | 2 +- development-tools/warnings.rst | 4 ++-- documentation/markup.rst | 2 +- getting-started/setup-building.rst | 4 ++-- testing/oss-fuzz.rst | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/developer-workflow/extension-modules.rst b/developer-workflow/extension-modules.rst index 4d8c0ffca1..cab46c834b 100644 --- a/developer-workflow/extension-modules.rst +++ b/developer-workflow/extension-modules.rst @@ -547,7 +547,7 @@ Now that the configuration is in place, it remains to compile the project: .. tip:: - Use ``make -jN`` to speed-up compilation by utilizing as many CPU cores + Use ``make -jN`` to speed up compilation by utilizing as many CPU cores as possible, where *N* is as many CPU cores you want to spare (and have memory for). Be careful using ``make -j`` with no argument, as this puts no limit on the number of jobs, and compilation can sometimes use up a diff --git a/developer-workflow/stdlib.rst b/developer-workflow/stdlib.rst index b683e55e96..ec10977221 100644 --- a/developer-workflow/stdlib.rst +++ b/developer-workflow/stdlib.rst @@ -126,7 +126,7 @@ If the module you want to propose adding to the stdlib meets the requirements, you may propose its inclusion by following the :abbr:`PEP (Python Enhancement Proposal)` process. See :pep:`1` for details, -and the :pep:`PEP index <0>` for previously-accepted PEPs +and the :pep:`PEP index <0>` for previously accepted PEPs that have proposed a module for inclusion. If the PEP is accepted, then the module will be added to the stdlib diff --git a/development-tools/warnings.rst b/development-tools/warnings.rst index b30d811311..1026082528 100644 --- a/development-tools/warnings.rst +++ b/development-tools/warnings.rst @@ -29,7 +29,7 @@ What to do if a warning check fails GitHub CI --------------------------------------------- The :cpy-file:`Tools/build/check_warnings.py` tool will fail if the compiler generates -more or less warnings than expected for a given source file as defined in the +more or fewer warnings than expected for a given source file as defined in the platform-specific warning ignore file. The warning ignore file is either :cpy-file:`Tools/build/.warningignore_ubuntu` or :cpy-file:`Tools/build/.warningignore_macos` depending on the platform. @@ -44,7 +44,7 @@ If a warning check fails with: warning ignore file. If the file exists in the warning ignore file increment the count by the number of newly introduced warnings. -* Unexpected improvements (less warnings) +* Unexpected improvements (fewer warnings) * Document in the PR that the change reduces the number of compiler warnings. Decrement the count in the platform-specific warning diff --git a/documentation/markup.rst b/documentation/markup.rst index 5ba8e4c7af..282b80f911 100644 --- a/documentation/markup.rst +++ b/documentation/markup.rst @@ -225,7 +225,7 @@ Explicit markup --------------- "Explicit markup" is used in reST for most constructs that need special -handling, such as footnotes, specially-highlighted paragraphs, comments, and +handling, such as footnotes, specially highlighted paragraphs, comments, and generic directives. An explicit markup block begins with a line starting with ``..`` followed by diff --git a/getting-started/setup-building.rst b/getting-started/setup-building.rst index 04e9a2143c..ee14c28d01 100644 --- a/getting-started/setup-building.rst +++ b/getting-started/setup-building.rst @@ -83,7 +83,7 @@ You will only need to execute these steps once per machine: (You can use both SSH-based or HTTPS-based URLs.) -.. Step 6 and 7 are are duplicated in bootcamp as well. +.. Step 6 and 7 are duplicated in bootcamp as well. Please update these steps in both places. 6. Add an ``upstream`` remote, then configure ``git`` @@ -508,7 +508,7 @@ used in ``python.sh``: Emscripten ---------- -Emscripten_ is a complete open-source compiler toolchain. It compiles C/C++ code +Emscripten_ is a complete open source compiler toolchain. It compiles C/C++ code into WebAssembly_/JavaScript executables, for use in JavaScript runtimes, including browsers and Node.js. diff --git a/testing/oss-fuzz.rst b/testing/oss-fuzz.rst index ec2449a4fd..dcee7c9985 100644 --- a/testing/oss-fuzz.rst +++ b/testing/oss-fuzz.rst @@ -2,7 +2,7 @@ OSS-Fuzz for CPython ==================== CPython uses `OSS-Fuzz `__, Google's -continuous fuzzing service for open-source projects, to find bugs and +continuous fuzzing service for open source projects, to find bugs and security vulnerabilities by feeding semi-random data to various APIs. CPython has two OSS-Fuzz projects: From ff11a8831d12331f1c864ee6076f5ee5c5ceed2b Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 23 May 2026 13:38:43 -0400 Subject: [PATCH 2/3] add hyphens to 'open-source' as adjectives --- core-team/motivations.rst | 12 ++++++------ core-team/responsibilities.rst | 2 +- developer-workflow/communication-channels.rst | 2 +- getting-started/setup-building.rst | 2 +- testing/oss-fuzz.rst | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/core-team/motivations.rst b/core-team/motivations.rst index d0e5a0cc18..7babb5f7da 100644 --- a/core-team/motivations.rst +++ b/core-team/motivations.rst @@ -115,7 +115,7 @@ participating in the CPython core development process: As a core team member, she is primarily interested in helping to ensure Python's continued suitability for educational, testing and data analysis use cases, as well as in encouraging good architectural practices when assembling Python - applications and test harnesses from open source components. + applications and test harnesses from open-source components. Note: prior to August 2023, Alyssa used her birth name (Nick Coghlan). Some records (for example, mailing list archives, version control history) will still reference that name. @@ -175,14 +175,14 @@ participating in the CPython core development process: available, working on the infrastructure that supports CPython development, specifically the Roundup-based bug tracker and the buildbot system. - David currently does both proprietary and open source development work, + David currently does both proprietary and open-source development work, primarily in Python, through the company in which he is a partner, `Murray & Walker, Inc `__. He has done contract work focused specifically on CPython development both through the PSF (the kickstart of the email Unicode API development) and directly funded by interested corporations (additional development work on email funded by QNX, and work on CPython ICC support funded by Intel). He would like to - spend more of his (and his company's) time on open source work, and so is + spend more of his (and his company's) time on open-source work, and so is actively seeking additional such contract opportunities. .. topic:: Antoine Pitrou (France) @@ -202,7 +202,7 @@ participating in the CPython core development process: concurrent programming. As a professional, Antoine has been first specializing in network - programming, and more lately in open source data science infrastructure. + programming, and more lately in open-source data science infrastructure. He has made numerous contributions to Numba, Dask and is currently working full time on Apache Arrow as a technical leader at QuantStack. @@ -269,7 +269,7 @@ participating in the CPython core development process: Carol is focused on Python's usage in education and scientific research. She is interested in distributed computing, organizational development, - operational workflows, and sustainability of open source projects. + operational workflows, and sustainability of open-source projects. .. _goals-of-the-motivations-page: @@ -282,7 +282,7 @@ strongly suggest that the current core development process is bottlenecked on core team time. This is most clearly indicated in the first metrics graph, which shows both the number of open issues and the number of pull requests awaiting review growing steadily over time, despite CPython being one of the most -active open source projects in the world. This bottleneck then impacts not only +active open-source projects in the world. This bottleneck then impacts not only resolving open issues and accepting submitted pull requests, but also the process of identifying, nominating and mentoring new core team members. diff --git a/core-team/responsibilities.rst b/core-team/responsibilities.rst index 9f5c62b728..130e763d56 100644 --- a/core-team/responsibilities.rst +++ b/core-team/responsibilities.rst @@ -123,7 +123,7 @@ to better assess the sustainability of current contributions to CPython core development, and also serves as a referral list for organisations seeking commercial Python support from the core development community. -And finally, enjoy yourself! Contributing to open source software should be fun +And finally, enjoy yourself! Contributing to open-source software should be fun (overall). If you find yourself no longer enjoying the work then either take a break or figure out what you need to do to make it enjoyable again. diff --git a/developer-workflow/communication-channels.rst b/developer-workflow/communication-channels.rst index a45003c783..101bb06122 100644 --- a/developer-workflow/communication-channels.rst +++ b/developer-workflow/communication-channels.rst @@ -270,7 +270,7 @@ that way. You can find their blogs (and various other developers who use Python) at `Planet Python `__. -Setting expectations for open source participation +Setting expectations for open-source participation ================================================== Burn-out is common in open source due to a misunderstanding of what users, contributors, diff --git a/getting-started/setup-building.rst b/getting-started/setup-building.rst index ee14c28d01..3590e09c3f 100644 --- a/getting-started/setup-building.rst +++ b/getting-started/setup-building.rst @@ -508,7 +508,7 @@ used in ``python.sh``: Emscripten ---------- -Emscripten_ is a complete open source compiler toolchain. It compiles C/C++ code +Emscripten_ is a complete open-source compiler toolchain. It compiles C/C++ code into WebAssembly_/JavaScript executables, for use in JavaScript runtimes, including browsers and Node.js. diff --git a/testing/oss-fuzz.rst b/testing/oss-fuzz.rst index dcee7c9985..ec2449a4fd 100644 --- a/testing/oss-fuzz.rst +++ b/testing/oss-fuzz.rst @@ -2,7 +2,7 @@ OSS-Fuzz for CPython ==================== CPython uses `OSS-Fuzz `__, Google's -continuous fuzzing service for open source projects, to find bugs and +continuous fuzzing service for open-source projects, to find bugs and security vulnerabilities by feeding semi-random data to various APIs. CPython has two OSS-Fuzz projects: From 0e63a1d2f6e748d703765c42a343e8982bd2160c Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 23 May 2026 13:43:51 -0400 Subject: [PATCH 3/3] add a style guide entry for 'open-source' --- documentation/style-guide.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index 28e4f21682..73618f9aec 100644 --- a/documentation/style-guide.rst +++ b/documentation/style-guide.rst @@ -84,6 +84,11 @@ free-threaded lock (GIL) optional (per :pep:`703`). Avoid using "No-GIL" to avoid double negatives (for example, "non-no-GIL"). +open source + Follow the usual English rules for compound words. When used as an + adjective, hyphenate: "open-source software". When used as a noun, don't use + a hypen: "open source is a collaboration model.." + POSIX The name assigned to a particular group of standards. This is always uppercase. @@ -92,7 +97,7 @@ Python The name of our favorite programming language is always capitalized. reST - For "reStructuredText," an easy to read, plaintext markup syntax + For "reStructuredText," an easy to read, plain-text markup syntax used to produce Python documentation. When spelled out, it is always one word and both forms start with a lowercase 'r'.