Skip to content

Commit 45e3338

Browse files
authored
Minor grammar fixes and a glossary entry for "open source" (#1809)
1 parent 87de350 commit 45e3338

9 files changed

Lines changed: 20 additions & 15 deletions

File tree

core-team/motivations.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ participating in the CPython core development process:
115115
As a core team member, she is primarily interested in helping to ensure Python's
116116
continued suitability for educational, testing and data analysis use cases,
117117
as well as in encouraging good architectural practices when assembling Python
118-
applications and test harnesses from open source components.
118+
applications and test harnesses from open-source components.
119119

120120
Note: prior to August 2023, Alyssa used her birth name (Nick Coghlan). Some records
121121
(for example, mailing list archives, version control history) will still reference that name.
@@ -175,14 +175,14 @@ participating in the CPython core development process:
175175
available, working on the infrastructure that supports CPython development,
176176
specifically the Roundup-based bug tracker and the buildbot system.
177177

178-
David currently does both proprietary and open source development work,
178+
David currently does both proprietary and open-source development work,
179179
primarily in Python, through the company in which he is a partner, `Murray &
180180
Walker, Inc <https://www.murrayandwalker.com>`__. He has done contract work
181181
focused specifically on CPython development both through the PSF (the
182182
kickstart of the email Unicode API development) and directly funded by
183183
interested corporations (additional development work on email funded by
184184
QNX, and work on CPython ICC support funded by Intel). He would like to
185-
spend more of his (and his company's) time on open source work, and so is
185+
spend more of his (and his company's) time on open-source work, and so is
186186
actively seeking additional such contract opportunities.
187187

188188
.. topic:: Antoine Pitrou (France)
@@ -202,7 +202,7 @@ participating in the CPython core development process:
202202
concurrent programming.
203203

204204
As a professional, Antoine has been first specializing in network
205-
programming, and more lately in open source data science infrastructure.
205+
programming, and more lately in open-source data science infrastructure.
206206
He has made numerous contributions to Numba, Dask and is currently working
207207
full time on Apache Arrow as a technical leader at QuantStack.
208208

@@ -269,7 +269,7 @@ participating in the CPython core development process:
269269

270270
Carol is focused on Python's usage in education and scientific research.
271271
She is interested in distributed computing, organizational development,
272-
operational workflows, and sustainability of open source projects.
272+
operational workflows, and sustainability of open-source projects.
273273

274274

275275
.. _goals-of-the-motivations-page:
@@ -282,7 +282,7 @@ strongly suggest that the current core development process is bottlenecked on
282282
core team time. This is most clearly indicated in the first metrics graph,
283283
which shows both the number of open issues and the number of pull requests awaiting
284284
review growing steadily over time, despite CPython being one of the most
285-
active open source projects in the world. This bottleneck then impacts not only
285+
active open-source projects in the world. This bottleneck then impacts not only
286286
resolving open issues and accepting submitted pull requests, but also the process of
287287
identifying, nominating and mentoring new core team members.
288288

core-team/responsibilities.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ to better assess the sustainability of current contributions to CPython core
123123
development, and also serves as a referral list for organisations seeking
124124
commercial Python support from the core development community.
125125

126-
And finally, enjoy yourself! Contributing to open source software should be fun
126+
And finally, enjoy yourself! Contributing to open-source software should be fun
127127
(overall). If you find yourself no longer enjoying the work then either take a
128128
break or figure out what you need to do to make it enjoyable again.
129129

developer-workflow/communication-channels.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ that way. You can find their blogs (and various other developers who use Python)
270270
at `Planet Python <https://planetpython.org/>`__.
271271

272272

273-
Setting expectations for open source participation
273+
Setting expectations for open-source participation
274274
==================================================
275275

276276
Burn-out is common in open source due to a misunderstanding of what users, contributors,

developer-workflow/extension-modules.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ Now that the configuration is in place, it remains to compile the project:
547547
548548
.. tip::
549549

550-
Use ``make -jN`` to speed-up compilation by utilizing as many CPU cores
550+
Use ``make -jN`` to speed up compilation by utilizing as many CPU cores
551551
as possible, where *N* is as many CPU cores you want to spare (and have
552552
memory for). Be careful using ``make -j`` with no argument, as this puts
553553
no limit on the number of jobs, and compilation can sometimes use up a

developer-workflow/stdlib.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ If the module you want to propose adding to the stdlib meets the requirements,
126126
you may propose its inclusion
127127
by following the :abbr:`PEP (Python Enhancement Proposal)` process.
128128
See :pep:`1` for details,
129-
and the :pep:`PEP index <0>` for previously-accepted PEPs
129+
and the :pep:`PEP index <0>` for previously accepted PEPs
130130
that have proposed a module for inclusion.
131131

132132
If the PEP is accepted, then the module will be added to the stdlib

development-tools/warnings.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ What to do if a warning check fails GitHub CI
2929
---------------------------------------------
3030

3131
The :cpy-file:`Tools/build/check_warnings.py` tool will fail if the compiler generates
32-
more or less warnings than expected for a given source file as defined in the
32+
more or fewer warnings than expected for a given source file as defined in the
3333
platform-specific warning ignore file. The warning ignore file is either
3434
:cpy-file:`Tools/build/.warningignore_ubuntu` or
3535
:cpy-file:`Tools/build/.warningignore_macos` depending on the platform.
@@ -44,7 +44,7 @@ If a warning check fails with:
4444
warning ignore file. If the file exists in the warning ignore file
4545
increment the count by the number of newly introduced warnings.
4646

47-
* Unexpected improvements (less warnings)
47+
* Unexpected improvements (fewer warnings)
4848

4949
* Document in the PR that the change reduces the number of compiler
5050
warnings. Decrement the count in the platform-specific warning

documentation/markup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Explicit markup
225225
---------------
226226

227227
"Explicit markup" is used in reST for most constructs that need special
228-
handling, such as footnotes, specially-highlighted paragraphs, comments, and
228+
handling, such as footnotes, specially highlighted paragraphs, comments, and
229229
generic directives.
230230

231231
An explicit markup block begins with a line starting with ``..`` followed by

documentation/style-guide.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ free-threaded
8484
lock (GIL) optional (per :pep:`703`). Avoid using "No-GIL" to avoid
8585
double negatives (for example, "non-no-GIL").
8686

87+
open source
88+
Follow the usual English rules for compound words. When used as an
89+
adjective, hyphenate: "open-source software". When used as a noun, don't use
90+
a hypen: "open source is a collaboration model.."
91+
8792
POSIX
8893
The name assigned to a particular group of standards. This is always
8994
uppercase.
@@ -92,7 +97,7 @@ Python
9297
The name of our favorite programming language is always capitalized.
9398

9499
reST
95-
For "reStructuredText," an easy to read, plaintext markup syntax
100+
For "reStructuredText," an easy to read, plain-text markup syntax
96101
used to produce Python documentation. When spelled out, it is
97102
always one word and both forms start with a lowercase 'r'.
98103

getting-started/setup-building.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ You will only need to execute these steps once per machine:
8383

8484
(You can use both SSH-based or HTTPS-based URLs.)
8585

86-
.. Step 6 and 7 are are duplicated in bootcamp as well.
86+
.. Step 6 and 7 are duplicated in bootcamp as well.
8787
Please update these steps in both places.
8888
8989
6. Add an ``upstream`` remote, then configure ``git``

0 commit comments

Comments
 (0)