Skip to content

Commit efa3c68

Browse files
authored
Remove e.g. and i.e. throughout (#1343)
1 parent 99b593e commit efa3c68

26 files changed

+114
-103
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Please note that all interactions on
66
infrastructure is [covered](https://www.python.org/psf/records/board/minutes/2014-01-06/#management-of-the-psfs-web-properties)
77
by the [PSF Code of Conduct](https://www.python.org/psf/conduct/),
88
which includes all infrastructure used in the development of Python itself
9-
(e.g. mailing lists, issue trackers, GitHub, etc.).
9+
(for example, mailing lists, issue trackers, GitHub, etc.).
1010

1111
In general this means everyone is expected to be open, considerate, and
1212
respectful of others no matter what their position is within the project.

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ our workflow that are not covered by a bot or status check are:
2929

3030
## Setting Expectations
3131

32-
Due to the fact that this project is entirely volunteer-run (i.e. no one is paid
32+
Due to the fact that this project is entirely volunteer-run (that is, no one is paid
3333
to work on Python full-time), we unfortunately can make no guarantees as to if
3434
or when a core developer will get around to reviewing your pull request.
3535
If no core developer has done a review or responded to changes made because of a

core-developers/committing.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ to enter the public source tree. Ask yourself the following questions:
4444
<https://discuss.python.org/c/core-dev/23>`__.
4545

4646
* **Does documentation need to be updated?**
47-
If the pull request introduces backwards-incompatible changes (e.g.
47+
If the pull request introduces backwards-incompatible changes (for example,
4848
deprecating or removing a feature), then make sure that those changes
4949
are reflected in the documentation before you merge the pull request.
5050

@@ -61,14 +61,14 @@ to enter the public source tree. Ask yourself the following questions:
6161
Make sure that the contributor has signed a `Contributor
6262
Licensing Agreement <https://www.python.org/psf/contrib/contrib-form/>`_
6363
(CLA), unless their change has no possible intellectual property
64-
associated with it (e.g. fixing a spelling mistake in documentation).
64+
associated with it (for example, fixing a spelling mistake in documentation).
6565
The `CPython CLA Bot <https://github.com/apps/cpython-cla-bot/>`_
6666
checks whether the author has signed the CLA, and replies in the PR
6767
if they haven't. For further questions about the CLA
6868
process, write to contributors@python.org.
6969

7070
* **Were** ``What's New in Python`` **and** ``Misc/NEWS.d/next`` **updated?**
71-
If the change is particularly interesting for end users (e.g. new features,
71+
If the change is particularly interesting for end users (for example, new features,
7272
significant improvements, or backwards-incompatible changes), then an
7373
entry in the ``What's New in Python`` document (in ``Doc/whatsnew/``) should
7474
be added as well. Changes that affect only documentation generally do not
@@ -97,7 +97,7 @@ For the last two, note the following:
9797

9898
#. **If a change is reverted prior to release**, then the corresponding
9999
entry is simply removed. Otherwise, a new entry must be added noting
100-
that the change has been reverted (e.g. when a feature is released in
100+
that the change has been reverted (for example, when a feature is released in
101101
an alpha and then cut prior to the first beta).
102102

103103
#. **If a change is a fix (or other adjustment) to an earlier unreleased
@@ -107,7 +107,7 @@ For the last two, note the following:
107107
Changes that require "What's New in Python" entries
108108
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
109109

110-
If a change is particularly interesting for end users (e.g. new features,
110+
If a change is particularly interesting for end users (for example, new features,
111111
significant improvements, or backwards-incompatible changes), add an entry in
112112
the "What's New in Python" document (in :cpy-file:`Doc/whatsnew/`)
113113
in addition to the ``NEWS`` entry.
@@ -130,16 +130,16 @@ or the :pypi:`blurb` tool and its ``blurb add`` command.
130130
If you are unable to use the tool, then you can create the ``NEWS`` entry file
131131
manually. The ``Misc/NEWS.d`` directory contains a sub-directory named
132132
``next``, which contains various sub-directories representing classifications
133-
for what was affected (e.g. ``Misc/NEWS.d/next/Library`` for changes relating
133+
for what was affected (for example, ``Misc/NEWS.d/next/Library`` for changes relating
134134
to the standard library). The file name itself should be in the format
135135
``<datetime>.gh-issue-<issue-number>.<nonce>.rst``:
136136

137137
* ``<datetime>`` is today's date joined with a hyphen (``-``) to your current
138-
local time, in the ``YYYY-MM-DD-hh-mm-ss`` format (e.g. ``2017-05-27-16-46-23``).
139-
* ``<issue-number>`` is the issue number the change is for (e.g. ``12345``
138+
local time, in the ``YYYY-MM-DD-hh-mm-ss`` format (for example, ``2017-05-27-16-46-23``).
139+
* ``<issue-number>`` is the issue number the change is for (for example, ``12345``
140140
for ``gh-issue-12345``).
141141
* ``<nonce>`` is a unique string to guarantee that the file name is
142-
unique across branches (e.g. ``Yl4gI2``). It is typically six characters
142+
unique across branches (for example, ``Yl4gI2``). It is typically six characters
143143
long, but it can be any length of letters and numbers. Its uniqueness
144144
can be satisfied by typing random characters on your keyboard.
145145

@@ -159,7 +159,7 @@ the reader to have read the actual diff for the change.
159159

160160
The contents of a ``NEWS`` file should be valid reStructuredText. An 80 character
161161
column width should be used. There is no indentation or leading marker in the
162-
file (e.g. ``-``). There is also no need to start the entry with the issue
162+
file (for example, ``-``). There is also no need to start the entry with the issue
163163
number since it is part of the file name. You can use
164164
:ref:`inline markups <rest-inline-markup>` too. Here is an example of a ``NEWS``
165165
entry::

core-developers/motivations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ participating in the CPython core development process:
8080
country of residence.
8181
8282
Include a "Crowdfunding" bullet point with a link if you'd like to highlight
83-
crowdfunding services (e.g. Patreon) that folks can use to support your core
83+
crowdfunding services (for example, Patreon) that folks can use to support your core
8484
development work.
8585
8686
Include additional bullet points (without links) for any other affiliations
@@ -116,7 +116,7 @@ participating in the CPython core development process:
116116
applications and test harnesses from open source components.
117117

118118
Note: prior to August 2023, Alyssa used her birth name (Nick Coghlan). Some records
119-
(e.g. mailing list archives, version control history) will still reference that name.
119+
(for example, mailing list archives, version control history) will still reference that name.
120120

121121
.. topic:: Steve Dower (United States/Australia)
122122

developer-workflow/c-api.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ Moving an API from the public tier to Unstable
219219
* Expose the API under its new name, with the ``PyUnstable_`` prefix.
220220
The ``PyUnstable_`` prefix must be used for all symbols (functions, macros,
221221
variables, etc.).
222-
* Make the old name an alias (e.g. a ``static inline`` function calling the
222+
* Make the old name an alias (for example, a ``static inline`` function calling the
223223
new function).
224224
* Deprecate the old name, typically using :c:macro:`Py_DEPRECATED`.
225225
* Announce the change in the "What's New".
@@ -255,7 +255,7 @@ Moving an API from unstable to public
255255
-------------------------------------
256256

257257
* Expose the API under its new name, without the ``PyUnstable_`` prefix.
258-
* Make the old ``PyUnstable_*`` name be an alias (e.g. a ``static inline``
258+
* Make the old ``PyUnstable_*`` name be an alias (for example, a ``static inline``
259259
function calling the new function).
260260
* Announce the change in What's New.
261261

@@ -393,7 +393,7 @@ Adding a new definition to the Limited API
393393
394394
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03yy0000
395395
396-
with the ``yy`` corresponding to the target CPython version, e.g.
396+
with the ``yy`` corresponding to the target CPython version, for example,
397397
``0x030A0000`` for Python 3.10.
398398
- Append an entry to the Stable ABI manifest, ``Misc/stable_abi.toml``
399399
- Regenerate the autogenerated files using ``make regen-limited-abi``.
@@ -426,7 +426,7 @@ To add a test file:
426426

427427
- Add a C file ``Modules/_testcapi/yourfeature_limited.c``. If that file
428428
already exists but its ``Py_LIMITED_API`` version is too low, add a version
429-
postfix, e.g. ``yourfeature_limited_3_12.c`` for Python 3.12+.
429+
postfix, for example, ``yourfeature_limited_3_12.c`` for Python 3.12+.
430430
- ``#define Py_LIMITED_API`` to the minimum limited API version needed.
431431
- ``#include "parts.h"`` after the ``Py_LIMITED_API`` definition
432432
- Enclose the entire rest of the file in ``#ifdef LIMITED_API_AVAILABLE``,

developer-workflow/development-cycle.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Some examples of release tags: ``v3.7.0a1``, ``v3.6.3``, ``v2.7.14rc1``.
3636
Branches
3737
--------
3838

39-
There is a branch for each *feature version*, whether released or not (e.g.
40-
3.7, 3.8).
39+
There is a branch for each *feature version*, whether released or not (for
40+
example, 3.7, 3.8).
4141

4242

4343
.. _indevbranch:
@@ -57,7 +57,7 @@ For versions 3.4 and before, this was conventionally done when the final
5757
release was cut (for example, 3.4.0 final).
5858

5959
Starting with the 3.5 release, we create the release maintenance branch
60-
(e.g. 3.5) at the time we enter beta (3.5.0 beta 1). This allows
60+
(``3.5``) at the time we enter beta (3.5.0 beta 1). This allows
6161
feature development for the release 3.n+1 to occur within the main
6262
branch alongside the beta and release candidate stabilization periods
6363
for release 3.n.
@@ -89,7 +89,7 @@ since most readers access the `stable documentation <https://docs.python.org/3/>
8989
rather than the `development documentation <https://docs.python.org/dev/>`__.
9090

9191
A new maintenance branch is normally created when the next feature release
92-
cycle reaches feature freeze, i.e. at its first beta pre-release.
92+
cycle reaches feature freeze, that is, at its first beta pre-release.
9393
From that point on, changes intended for remaining pre-releases, the final
9494
release (3.x.0), and subsequent bugfix releases are merged to
9595
that maintenance branch.
@@ -131,7 +131,7 @@ End-of-life branches
131131
The code base for a release cycle which has reached end-of-life status
132132
is frozen and no longer has a branch in the repo. The final state of
133133
the end-of-lifed branch is recorded as a tag with the same name as the
134-
former branch, e.g. ``3.3`` or ``2.6``.
134+
former branch, for example, ``3.3`` or ``2.6``.
135135

136136
The :ref:`versions` page contains list of active and end-of-life branches.
137137

@@ -191,7 +191,7 @@ Release Candidate (RC)
191191

192192
A branch preparing for an RC release can only have bugfixes applied that have
193193
been reviewed by other core developers. Generally, these issues must be
194-
severe enough (e.g. crashes) that they deserve fixing before the final release.
194+
severe enough (for example, crashes) that they deserve fixing before the final release.
195195
All other issues should be deferred to the next development cycle, since
196196
stability is the strongest concern at this point.
197197

@@ -227,13 +227,13 @@ repositories are expected to relate to the Python language, the CPython
227227
reference implementation, their documentation and their development workflow.
228228
This includes, for example:
229229

230-
* The reference implementation of Python and related repositories (i.e. `CPython <https://github.com/python/cpython>`_)
231-
* Tooling and support around CPython development (e.g. `pyperformance <https://github.com/python/pyperformance>`_, `Bedevere <https://github.com/python/bedevere>`_)
232-
* Helpers and backports for Python/CPython features (e.g. `typing_extensions <https://github.com/python/typing_extensions>`_, `typeshed <https://github.com/python/typeshed>`_, `tzdata <https://github.com/python/tzdata>`_, `pythoncapi-compat <https://github.com/python/pythoncapi-compat>`_)
233-
* Organization-related repositories (e.g. the `Code of Conduct <https://github.com/python/pycon-code-of-conduct>`_, `.github <https://github.com/python/.github>`_)
234-
* Documentation and websites for all the above (e.g. `python.org repository <https://github.com/python/pythondotorg>`_, `PEPs <https://github.com/python/peps>`_, `Devguide <https://github.com/python/devguide>`_, docs translations)
235-
* Infrastructure for all the above (e.g. `docsbuild-scripts <https://github.com/python/docsbuild-scripts>`_, `buildmaster-config <https://github.com/python/buildmaster-config>`_)
236-
* Discussions and notes around official development-related processes and events (e.g. `steering-council <https://github.com/python/steering-council>`_, `core-sprint <https://github.com/python/core-sprint>`_)
230+
* The reference implementation of Python and related repositories: `CPython <https://github.com/python/cpython>`_.
231+
* Tooling and support around CPython development: `pyperformance <https://github.com/python/pyperformance>`_, `Bedevere <https://github.com/python/bedevere>`_.
232+
* Helpers and backports for Python/CPython features: `typing_extensions <https://github.com/python/typing_extensions>`_, `typeshed <https://github.com/python/typeshed>`_, `tzdata <https://github.com/python/tzdata>`_, `pythoncapi-compat <https://github.com/python/pythoncapi-compat>`_.
233+
* Organization-related repositories: the `Code of Conduct <https://github.com/python/pycon-code-of-conduct>`_, `.github <https://github.com/python/.github>`_.
234+
* Documentation and websites for all the above: `python.org repository <https://github.com/python/pythondotorg>`_, `PEPs <https://github.com/python/peps>`_, `Devguide <https://github.com/python/devguide>`_, docs translations.
235+
* Infrastructure for all the above: `docsbuild-scripts <https://github.com/python/docsbuild-scripts>`_, `buildmaster-config <https://github.com/python/buildmaster-config>`_.
236+
* Discussions and notes around official development-related processes and events: `steering-council <https://github.com/python/steering-council>`_, `core-sprint <https://github.com/python/core-sprint>`_.
237237

238238
Before adding a new repository to the organization, open a discussion to seek consensus
239239
in the `Committers Discourse category <https://discuss.python.org/c/committers/5>`_.
@@ -248,13 +248,13 @@ accounts or other GitHub orgs. It is relatively easy to move a repository to
248248
the organization once it is mature. For example, this would now apply to
249249
experimental features like `asyncio <https://github.com/python/asyncio>`_,
250250
`exceptiongroups <https://github.com/python/exceptiongroups>`_,
251-
and drafts of new guides and other documentation (e.g. `redistributor-guide
251+
and drafts of new guides and other documentation (for example, `redistributor-guide
252252
<https://github.com/python/redistributor-guide>`_).
253253

254-
General-use tools and libraries (e.g. `mypy <https://github.com/python/mypy>`_
254+
General-use tools and libraries (for example, `mypy <https://github.com/python/mypy>`_
255255
or `Black <https://github.com/psf/black>`_) should also be developed outside
256256
the ``python`` organization, unless core devs (as represented by the SC)
257-
specifically want to “bless” one implementation (as with e.g.
257+
specifically want to “bless” one implementation (as with
258258
`typeshed <https://github.com/python/typeshed>`_,
259259
`tzdata <https://github.com/python/tzdata>`_, or
260260
`pythoncapi-compat <https://github.com/python/pythoncapi-compat>`_).

developer-workflow/porting.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ which it has already been ported; preferably Unix, but Windows will
1313
do, too. The build process for Python, in particular the ``Makefile`` in the
1414
source distribution, will give you a hint on which files to compile
1515
for Python. Not all source files are relevant: some are platform-specific,
16-
and others are only used in emergencies (e.g. ``getopt.c``).
16+
and others are only used in emergencies (for example, ``getopt.c``).
1717

1818
It is not recommended to start porting Python without at least a medium-level
19-
understanding of your target platform; i.e. how it is generally used, how to
20-
write platform-specific apps, etc. Also, some Python knowledge is required, or
19+
understanding of your target platform; how it is generally used, how to
20+
write platform-specific apps, and so on. Also, some Python knowledge is required, or
2121
you will be unable to verify that your port is working correctly.
2222

2323
You will need a ``pyconfig.h`` file tailored for your platform. You can

developer-workflow/stdlib.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ year, a module needs to have established itself as (one of) the top choices by
108108
the community for solving the problem the module is intended for.
109109

110110
The development of the module must move into Python's
111-
infrastructure (i.e., the module is no longer directly maintained outside of
111+
infrastructure (that is, the module is no longer directly maintained outside of
112112
Python). This prevents a divergence between the code that is included in the
113113
stdlib and that which is released outside the stdlib (typically done to provide
114114
the module to older versions of Python). It also removes the burden of forcing

development-tools/clinic.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Classes for extending Argument Clinic
213213

214214
The C type to use for this variable.
215215
:attr:`!type` should be a Python string specifying the type,
216-
e.g. ``'int'``.
216+
for example, ``'int'``.
217217
If this is a pointer type, the type string should end with ``' *'``.
218218

219219
.. attribute:: default

development-tools/gdb.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Fortunately, among the `many ways to set breakpoints
3333
you can break at C labels, such as those generated for computed gotos.
3434
If you are debugging an interpreter compiled with computed goto support
3535
(generally true, certainly when using GCC), each instruction will be
36-
prefaced with a label named ``TARGET_<instruction>``, e.g.,
36+
prefaced with a label named ``TARGET_<instruction>``, for example,
3737
``TARGET_LOAD_CONST``. You can then set a breakpoint with a command
3838
like::
3939

documentation/help-documenting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Proofreading
7474
While an issue filed on the `issue tracker`_ means there is a known issue
7575
somewhere, that does not mean there are not other issues lurking about in the
7676
documentation. Proofreading a part of the documentation, such as a "How to" or
77-
OS specific document, can often uncover problems (e.g., documentation that
77+
OS specific document, can often uncover problems (for example, documentation that
7878
needs updating for Python 3).
7979

8080
If you decide to proofread, read a section of the documentation from start

0 commit comments

Comments
 (0)