Skip to content

Commit 7ac2c8f

Browse files
Apply fixes per review
s/couple/few/ Add "abbreviation" alongside "acronym" in style guide. Remove all existing uses of `:abbr:`. Where trivial, the text is reflowed to wrap more naturally. Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
1 parent d0cdf9e commit 7ac2c8f

8 files changed

Lines changed: 13 additions & 14 deletions

File tree

developer-workflow/development-cycle.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Stages
146146

147147
Based on what stage the :ref:`in-development <indevbranch>` version of Python
148148
is in, the responsibilities of a core team member change in regards to commits
149-
to the :abbr:`VCS (version control system)`.
149+
to the VCS (version control system).
150150

151151

152152
Pre-alpha

developer-workflow/stdlib.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Python). This prevents a divergence between the code that is included in the
109109
stdlib and that which is released outside the stdlib (typically done to provide
110110
the module to older versions of Python). It also removes the burden of forcing
111111
the core team to have to redirect bug reports or changes to an external issue
112-
tracker and :abbr:`VCS (version control system)`.
112+
tracker and VCS (version control system).
113113

114114
Someone involved with the development of the
115115
module must promise to help maintain the module in the stdlib for two years.
@@ -124,7 +124,7 @@ Proposal process
124124

125125
If the module you want to propose adding to the stdlib meets the requirements,
126126
you may propose its inclusion
127-
by following the :abbr:`PEP (Python Enhancement Proposal)` process.
127+
by following the PEP (Python Enhancement Proposal) process.
128128
See :pep:`1` for details,
129129
and the :pep:`PEP index <0>` for previously accepted PEPs
130130
that have proposed a module for inclusion.

development-tools/clinic/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Terminology
148148
Command-line interface
149149
----------------------
150150

151-
The Argument Clinic :abbr:`CLI (Command-Line Interface)` is typically used to
151+
The Argument Clinic CLI (Command-Line Interface) is typically used to
152152
process a single source file, like this:
153153

154154
.. code-block:: shell-session

documentation/markup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@ As :ref:`previously mentioned <inline-markup>`, Sphinx uses
699699
interpreted text roles of the form ``:rolename:`content```
700700
to insert semantic markup in documents.
701701

702-
In the CPython documentation, there are a couple common cases
702+
In the CPython documentation, there are a few common cases
703703
where simpler markup should be used:
704704

705705
* ``*arg*`` (rendered as *arg*) for function and method arguments.

documentation/style-guide.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ be native English speakers.
6868
Don't use Latin abbreviations like "e.g." or "i.e." where English words will do,
6969
such as "for example" or "that is."
7070

71-
In general, the first time an acronym is used on a page, spell it out.
71+
In general, the first time an acronym or abbreviation is used on a page, spell
72+
it out.
7273
Prefer to write out the full term and follow it with the acronym in parentheses.
7374
For example, write "Basic Multilingual Plane (BMP)".
7475
Commonly understood acronyms, such as "HTML" and "UTF-8", should not be expanded.

getting-started/pull-request-lifecycle.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -710,11 +710,10 @@ do not take it personally! Your work is still appreciated regardless of whether
710710
your pull request is merged. Balancing what *does* and *does not* go into
711711
Python is tricky and we simply cannot accept everyone's contributions.
712712

713-
But if your pull request is merged it will then go into Python's
714-
:abbr:`VCS (version control system)` to be released
715-
with the next feature release of Python. It may also be backported to older
716-
versions of Python as a bugfix if the core team member doing the merge believes
717-
it is warranted.
713+
But if your pull request is merged it will then go into Python's VCS (version
714+
control system) to be released with the next feature release of Python.
715+
It may also be backported to older versions of Python as a bugfix if the core
716+
team member doing the merge believes it is warranted.
718717

719718

720719
Crediting

getting-started/setup-building.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1107,8 +1107,7 @@ every rule.
11071107
See also :ref:`building-doc`.
11081108

11091109
``Grammar``
1110-
Contains the :abbr:`PEG (Parser Expression Grammar)` grammar file for
1111-
Python.
1110+
Contains the PEG (Parser Expression Grammar) grammar file for Python.
11121111

11131112
``Include``
11141113
Contains all interpreter-wide header files.

testing/coverage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Increase test coverage
77
.. include:: /include/activate-tab.rst
88

99
Python development follows a practice that all semantic changes and additions
10-
to the language and :abbr:`stdlib (standard library)` are accompanied by
10+
to the language and stdlib (standard library) are accompanied by
1111
appropriate unit tests. Unfortunately Python was in existence for a long time
1212
before the practice came into effect. This has left chunks of the stdlib
1313
untested which is not a desirable situation to be in.

0 commit comments

Comments
 (0)