Skip to content

Commit 5d27e91

Browse files
authored
Fix typos to follow style guide (#1163)
1 parent dbccd83 commit 5d27e91

File tree

9 files changed

+31
-31
lines changed

9 files changed

+31
-31
lines changed

core-developers/motivations.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ participating in the CPython core development process:
166166
business started declining) to being a full time independent consultant,
167167
David started contributing directly to CPython development. He became a
168168
committer in 2009. He subsequently took over primary maintenance of the
169-
email package from Barry Warsaw, and contributed the unicode oriented API.
169+
email package from Barry Warsaw, and contributed the Unicode oriented API.
170170
David is also active in mentoring new contributors and, when time is
171171
available, working on the infrastructure that supports CPython development,
172172
specifically the Roundup-based bug tracker and the buildbot system.
@@ -175,7 +175,7 @@ participating in the CPython core development process:
175175
primarily in Python, through the company in which he is a partner, `Murray &
176176
Walker, Inc <https://www.murrayandwalker.com>`_. He has done contract work
177177
focused specifically on CPython development both through the PSF (the
178-
kickstart of the email unicode API development) and directly funded by
178+
kickstart of the email Unicode API development) and directly funded by
179179
interested corporations (additional development work on email funded by
180180
QNX, and work on CPython ICC support funded by Intel). He would like to
181181
spend more of his (and his company's) time on open source work, and so is

documentation/style-guide.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ sections are in title case, you can either convert all titles to
5656
sentence case or use the dominant style in the new section title.
5757

5858
Sentences that start with a word for which specific rules require
59-
starting it with a lower case letter should be avoided.
59+
starting it with a lowercase letter should be avoided.
6060

6161
.. note::
6262

@@ -92,7 +92,7 @@ Python
9292
reST
9393
For "reStructuredText," an easy to read, plaintext markup syntax
9494
used to produce Python documentation. When spelled out, it is
95-
always one word and both forms start with a lower case 'r'.
95+
always one word and both forms start with a lowercase 'r'.
9696

9797
Unicode
9898
The name of a character coding system. This is always written

documentation/translating.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ The important steps look like this:
151151
- Create the GitHub repo (anywhere) with the right hierarchy (using the
152152
cookiecutter).
153153
- Gather people to help you translate. You can't do it alone.
154-
- You can use any tool to translate, as long as you can synchronize with git.
154+
- You can use any tool to translate, as long as you can synchronize with Git.
155155
Some use Transifex, and some use only GitHub. You can choose another
156156
way if you like; it's up to you.
157157
- Ensure we update this page to reflect your work and progress, either via a
@@ -211,7 +211,7 @@ Here's what we're using:
211211
from one file to others.
212212
- `pospell <https://pypi.org/project/pospell/>`__ to check for typos in ``.po`` files.
213213
- `powrap <https://pypi.org/project/powrap/>`__ to rewrap the ``.po`` files
214-
before committing. This helps keep git diffs short.
214+
before committing. This helps keep Git diffs short.
215215
- `potodo <https://pypi.org/project/potodo/>`__ to list what needs to be translated.
216216

217217

@@ -240,15 +240,15 @@ Ask on the `translation mailing list <translation_ml_>`_, or better, make a PR o
240240
<https://github.com/python/devguide/>`__.
241241

242242

243-
I have a translation, but it's not in git. What should I do?
243+
I have a translation, but it's not in Git. What should I do?
244244
------------------------------------------------------------
245245

246246
You can ask for help on the `translation mailing list <translation_ml_>`_, and
247247
the team will help you create an appropriate repository. You can still use tools like transifex,
248248
if you like.
249249

250250

251-
My git hierarchy does not match yours. Can I keep it?
251+
My Git hierarchy does not match yours. Can I keep it?
252252
-----------------------------------------------------
253253

254254
No, inside the ``github.com/python`` organization we’ll all have the

getting-started/git-boot-camp.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Git Bootcamp and Cheat Sheet
1010

1111
This section provides instructions on common tasks in CPython's
1212
workflow. It's designed to assist new contributors who have
13-
some familiarity with git and GitHub.
13+
some familiarity with Git and GitHub.
1414

15-
If you are new to git and GitHub, please become comfortable with
15+
If you are new to Git and GitHub, please become comfortable with
1616
these instructions before submitting a pull request. As there are several
17-
ways to accomplish these tasks using git and GitHub, this section reflects
17+
ways to accomplish these tasks using Git and GitHub, this section reflects
1818
one method suitable for new contributors. Experienced contributors may
1919
desire a different approach.
2020

@@ -23,9 +23,9 @@ In this section, we will go over some commonly used Git commands that are
2323
relevant to CPython's workflow.
2424

2525
.. note::
26-
Setting up git aliases for common tasks can be useful to you. You can
26+
Setting up Git aliases for common tasks can be useful to you. You can
2727
get more information about that in
28-
`git documentation <https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases>`_
28+
`Git documentation <https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases>`_
2929

3030
.. _fork-cpython:
3131

@@ -544,7 +544,7 @@ page. Find the event that says something like::
544544

545545
By following the link to ``<commit_sha1>``, you will get the full commit hash.
546546

547-
Alternatively, the commit hash can also be obtained by the following git
547+
Alternatively, the commit hash can also be obtained by the following Git
548548
commands:
549549

550550
.. code-block:: bash

getting-started/pull-request-lifecycle.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ You should have already :ref:`set up your system <setup>`,
132132
git pull origin <branch-name> # pull = fetch + merge
133133

134134
If you have made local changes that have not been pushed to your fork and
135-
there are merge conflicts, git will warn you about this and enter conflict
135+
there are merge conflicts, Git will warn you about this and enter conflict
136136
resolution mode. See :ref:`resolving-merge-conflicts` below.
137137

138138
* If time passes and there are merge conflicts with the main branch, GitHub
@@ -165,14 +165,14 @@ resolved as follows:
165165
git status
166166

167167
#. Edit the affected files and bring them to their intended final state.
168-
Make sure to remove the special "conflict markers" inserted by git.
168+
Make sure to remove the special "conflict markers" inserted by Git.
169169

170170
#. Commit the affected files::
171171

172172
git add <filenames>
173173
git merge --continue
174174

175-
When running the final command, git may open an editor for writing a commit
175+
When running the final command, Git may open an editor for writing a commit
176176
message. It is usually okay to leave that as-is and close the editor.
177177

178178
See `the merge command's documentation <https://git-scm.com/docs/git-merge>`_
@@ -241,7 +241,7 @@ should do to help ensure that your pull request is accepted.
241241
``patchcheck`` is a simple automated patch checklist that guides a developer
242242
through the common patch generation checks. To run ``patchcheck``:
243243

244-
On *UNIX* (including macOS)::
244+
On *Unix* (including macOS)::
245245

246246
make patchcheck
247247

@@ -303,7 +303,7 @@ to explain in proper depth what has happened (detail should be good enough
303303
that a core developer reading the commit message understands the
304304
justification for the change).
305305

306-
Check :ref:`the git bootcamp <accepting-and-merging-a-pr>` for further
306+
Check :ref:`the Git bootcamp <accepting-and-merging-a-pr>` for further
307307
instructions on how the commit message should look like when merging a pull
308308
request.
309309

getting-started/setup-building.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,28 @@ directory structure of the CPython source code.
1515
Alternatively, if you have `Docker <https://www.docker.com/>`_ installed you
1616
might want to use `our official images
1717
<https://gitlab.com/python-devs/ci-images/blob/main/README.md>`_. These
18-
contain the latest releases of several Python versions, along with git head,
18+
contain the latest releases of several Python versions, along with Git head,
1919
and are provided for development and testing purposes only.
2020

2121
.. seealso::
2222

2323
The :ref:`quick-reference` gives brief summary of the process from
24-
installing git to submitting a pull request.
24+
installing Git to submitting a pull request.
2525

2626
.. _vcsetup:
2727

28-
Install ``git``
29-
===============
28+
Install Git
29+
===========
3030

31-
CPython is developed using `git <https://git-scm.com>`_ for version control. The git
32-
command line program is named ``git``; this is also used to refer to git
33-
itself. git is easily available for all common operating systems.
31+
CPython is developed using `Git <https://git-scm.com>`_ for version control. The Git
32+
command line program is named ``git``; this is also used to refer to Git
33+
itself. Git is easily available for all common operating systems.
3434

3535
- **Install**
3636

3737
As the CPython repo is hosted on GitHub, please refer to either the
3838
`GitHub setup instructions <https://docs.github.com/en/get-started/quickstart/set-up-git>`_
39-
or the `git project instructions <https://git-scm.com>`_ for step-by-step
39+
or the `Git project instructions <https://git-scm.com>`_ for step-by-step
4040
installation directions. You may also want to consider a graphical client
4141
such as `TortoiseGit <https://tortoisegit.org/>`_ or
4242
`GitHub Desktop <https://desktop.github.com/>`_.

index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ instructions please see the :ref:`setup guide <setup>`.
2727
git clone https://github.com/<your_username>/cpython
2828
cd cpython
2929

30-
3. Build Python, on UNIX and macOS use::
30+
3. Build Python, on Unix and macOS use::
3131

3232
./configure --with-pydebug && make -j
3333

@@ -39,7 +39,7 @@ instructions please see the :ref:`setup guide <setup>`.
3939

4040
See also :ref:`more detailed instructions <compiling>`,
4141
:ref:`how to install and build dependencies <build-dependencies>`,
42-
and the platform-specific pages for :ref:`UNIX <unix-compiling>`,
42+
and the platform-specific pages for :ref:`Unix <unix-compiling>`,
4343
:ref:`macOS`, and :ref:`Windows <windows-compiling>`.
4444

4545
4. :ref:`Run the tests <runtests>`::

internals/parser.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,7 @@ Pegen has some special grammatical elements and rules:
570570

571571
* Strings with single quotes (') (e.g. ``'class'``) denote KEYWORDS.
572572
* Strings with double quotes (") (e.g. ``"match"``) denote SOFT KEYWORDS.
573-
* Upper case names (e.g. ``NAME``) denote tokens in the :cpy-file:`Grammar/Tokens` file.
573+
* Uppercase names (e.g. ``NAME``) denote tokens in the :cpy-file:`Grammar/Tokens` file.
574574
* Rule names starting with ``invalid_`` are used for specialized syntax errors.
575575

576576
- These rules are NOT used in the first pass of the parser.

testing/new-buildbot-worker.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ contribute a buildbot but have questions.
2626

2727
As for what kind of buildbot to run...take a look at our `current fleet
2828
<https://buildbot.python.org/all/>`_. Pretty much anything that isn't
29-
on that list would be interesting: different Linux/UNIX distributions,
29+
on that list would be interesting: different Linux/Unix distributions,
3030
different versions of the various OSes, other OSes if you or someone are
3131
prepared to make the test suite actually pass on that new OS. Even if you only
3232
want to run an OS that's already on our list there may be utility in setting it

0 commit comments

Comments
 (0)