diff --git a/core-developers/motivations.rst b/core-developers/motivations.rst index 625c763d97..abc23aad74 100644 --- a/core-developers/motivations.rst +++ b/core-developers/motivations.rst @@ -166,7 +166,7 @@ participating in the CPython core development process: business started declining) to being a full time independent consultant, David started contributing directly to CPython development. He became a committer in 2009. He subsequently took over primary maintenance of the - email package from Barry Warsaw, and contributed the unicode oriented API. + email package from Barry Warsaw, and contributed the Unicode oriented API. David is also active in mentoring new contributors and, when time is available, working on the infrastructure that supports CPython development, specifically the Roundup-based bug tracker and the buildbot system. @@ -175,7 +175,7 @@ participating in the CPython core development process: 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 + 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 diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index f5dfe45704..ae4b8ed6ee 100644 --- a/documentation/style-guide.rst +++ b/documentation/style-guide.rst @@ -56,7 +56,7 @@ sections are in title case, you can either convert all titles to sentence case or use the dominant style in the new section title. Sentences that start with a word for which specific rules require -starting it with a lower case letter should be avoided. +starting it with a lowercase letter should be avoided. .. note:: @@ -92,7 +92,7 @@ Python reST For "reStructuredText," an easy to read, plaintext markup syntax used to produce Python documentation. When spelled out, it is - always one word and both forms start with a lower case 'r'. + always one word and both forms start with a lowercase 'r'. Unicode The name of a character coding system. This is always written diff --git a/documentation/translating.rst b/documentation/translating.rst index eb19bf4685..d71d4b65f7 100644 --- a/documentation/translating.rst +++ b/documentation/translating.rst @@ -151,7 +151,7 @@ The important steps look like this: - Create the GitHub repo (anywhere) with the right hierarchy (using the cookiecutter). - Gather people to help you translate. You can't do it alone. -- You can use any tool to translate, as long as you can synchronize with git. +- You can use any tool to translate, as long as you can synchronize with Git. Some use Transifex, and some use only GitHub. You can choose another way if you like; it's up to you. - Ensure we update this page to reflect your work and progress, either via a @@ -211,7 +211,7 @@ Here's what we're using: from one file to others. - `pospell `__ to check for typos in ``.po`` files. - `powrap `__ to rewrap the ``.po`` files - before committing. This helps keep git diffs short. + before committing. This helps keep Git diffs short. - `potodo `__ to list what needs to be translated. @@ -240,7 +240,7 @@ Ask on the `translation mailing list `_, or better, make a PR o `__. -I have a translation, but it's not in git. What should I do? +I have a translation, but it's not in Git. What should I do? ------------------------------------------------------------ You can ask for help on the `translation mailing list `_, and @@ -248,7 +248,7 @@ the team will help you create an appropriate repository. You can still use tools if you like. -My git hierarchy does not match yours. Can I keep it? +My Git hierarchy does not match yours. Can I keep it? ----------------------------------------------------- No, inside the ``github.com/python`` organization we’ll all have the diff --git a/getting-started/git-boot-camp.rst b/getting-started/git-boot-camp.rst index 082232cee7..c9c6c9da92 100644 --- a/getting-started/git-boot-camp.rst +++ b/getting-started/git-boot-camp.rst @@ -10,11 +10,11 @@ Git Bootcamp and Cheat Sheet This section provides instructions on common tasks in CPython's workflow. It's designed to assist new contributors who have - some familiarity with git and GitHub. + some familiarity with Git and GitHub. - If you are new to git and GitHub, please become comfortable with + If you are new to Git and GitHub, please become comfortable with these instructions before submitting a pull request. As there are several - ways to accomplish these tasks using git and GitHub, this section reflects + ways to accomplish these tasks using Git and GitHub, this section reflects one method suitable for new contributors. Experienced contributors may desire a different approach. @@ -23,9 +23,9 @@ In this section, we will go over some commonly used Git commands that are relevant to CPython's workflow. .. note:: - Setting up git aliases for common tasks can be useful to you. You can + Setting up Git aliases for common tasks can be useful to you. You can get more information about that in - `git documentation `_ + `Git documentation `_ .. _fork-cpython: @@ -544,7 +544,7 @@ page. Find the event that says something like:: By following the link to ````, you will get the full commit hash. -Alternatively, the commit hash can also be obtained by the following git +Alternatively, the commit hash can also be obtained by the following Git commands: .. code-block:: bash diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index 5c81d0a99c..54242ac1f2 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -132,7 +132,7 @@ You should have already :ref:`set up your system `, git pull origin # pull = fetch + merge If you have made local changes that have not been pushed to your fork and - there are merge conflicts, git will warn you about this and enter conflict + there are merge conflicts, Git will warn you about this and enter conflict resolution mode. See :ref:`resolving-merge-conflicts` below. * If time passes and there are merge conflicts with the main branch, GitHub @@ -165,14 +165,14 @@ resolved as follows: git status #. Edit the affected files and bring them to their intended final state. - Make sure to remove the special "conflict markers" inserted by git. + Make sure to remove the special "conflict markers" inserted by Git. #. Commit the affected files:: git add git merge --continue -When running the final command, git may open an editor for writing a commit +When running the final command, Git may open an editor for writing a commit message. It is usually okay to leave that as-is and close the editor. See `the merge command's documentation `_ @@ -241,7 +241,7 @@ should do to help ensure that your pull request is accepted. ``patchcheck`` is a simple automated patch checklist that guides a developer through the common patch generation checks. To run ``patchcheck``: - On *UNIX* (including macOS):: + On *Unix* (including macOS):: make patchcheck @@ -303,7 +303,7 @@ to explain in proper depth what has happened (detail should be good enough that a core developer reading the commit message understands the justification for the change). -Check :ref:`the git bootcamp ` for further +Check :ref:`the Git bootcamp ` for further instructions on how the commit message should look like when merging a pull request. diff --git a/getting-started/setup-building.rst b/getting-started/setup-building.rst index e91ee07b8f..b507d58aa9 100644 --- a/getting-started/setup-building.rst +++ b/getting-started/setup-building.rst @@ -15,28 +15,28 @@ directory structure of the CPython source code. Alternatively, if you have `Docker `_ installed you might want to use `our official images `_. These -contain the latest releases of several Python versions, along with git head, +contain the latest releases of several Python versions, along with Git head, and are provided for development and testing purposes only. .. seealso:: The :ref:`quick-reference` gives brief summary of the process from - installing git to submitting a pull request. + installing Git to submitting a pull request. .. _vcsetup: -Install ``git`` -=============== +Install Git +=========== -CPython is developed using `git `_ for version control. The git -command line program is named ``git``; this is also used to refer to git -itself. git is easily available for all common operating systems. +CPython is developed using `Git `_ for version control. The Git +command line program is named ``git``; this is also used to refer to Git +itself. Git is easily available for all common operating systems. - **Install** As the CPython repo is hosted on GitHub, please refer to either the `GitHub setup instructions `_ - or the `git project instructions `_ for step-by-step + or the `Git project instructions `_ for step-by-step installation directions. You may also want to consider a graphical client such as `TortoiseGit `_ or `GitHub Desktop `_. diff --git a/index.rst b/index.rst index 2272cc74bc..3ff4fb47f5 100644 --- a/index.rst +++ b/index.rst @@ -27,7 +27,7 @@ instructions please see the :ref:`setup guide `. git clone https://github.com//cpython cd cpython -3. Build Python, on UNIX and macOS use:: +3. Build Python, on Unix and macOS use:: ./configure --with-pydebug && make -j @@ -39,7 +39,7 @@ instructions please see the :ref:`setup guide `. See also :ref:`more detailed instructions `, :ref:`how to install and build dependencies `, - and the platform-specific pages for :ref:`UNIX `, + and the platform-specific pages for :ref:`Unix `, :ref:`macOS`, and :ref:`Windows `. 4. :ref:`Run the tests `:: diff --git a/internals/parser.rst b/internals/parser.rst index aa035c1a77..323cc0feaf 100644 --- a/internals/parser.rst +++ b/internals/parser.rst @@ -570,7 +570,7 @@ Pegen has some special grammatical elements and rules: * Strings with single quotes (') (e.g. ``'class'``) denote KEYWORDS. * Strings with double quotes (") (e.g. ``"match"``) denote SOFT KEYWORDS. -* Upper case names (e.g. ``NAME``) denote tokens in the :cpy-file:`Grammar/Tokens` file. +* Uppercase names (e.g. ``NAME``) denote tokens in the :cpy-file:`Grammar/Tokens` file. * Rule names starting with ``invalid_`` are used for specialized syntax errors. - These rules are NOT used in the first pass of the parser. diff --git a/testing/new-buildbot-worker.rst b/testing/new-buildbot-worker.rst index 1beaa3afa9..6bbeb1ee43 100644 --- a/testing/new-buildbot-worker.rst +++ b/testing/new-buildbot-worker.rst @@ -26,7 +26,7 @@ contribute a buildbot but have questions. As for what kind of buildbot to run...take a look at our `current fleet `_. Pretty much anything that isn't -on that list would be interesting: different Linux/UNIX distributions, +on that list would be interesting: different Linux/Unix distributions, different versions of the various OSes, other OSes if you or someone are prepared to make the test suite actually pass on that new OS. Even if you only want to run an OS that's already on our list there may be utility in setting it