Skip to content

Commit 0454c8e

Browse files
authored
Merge pull request #1855 from nedbat/nedbat/proofread
minor copy-editing fixes
2 parents 451aee8 + 480dbb9 commit 0454c8e

9 files changed

+14
-14
lines changed

source/contribute.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ including:
1111
* Reviewing new contributions
1212
* Revising existing content
1313
* Writing new content
14-
* Translate the guide
14+
* Translating the guide
1515

1616
Most of the work on the |PyPUG| takes place on the
1717
`project's GitHub repository`__. To get started, check out the list of

source/discussions/deploying-python-applications.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Supporting multiple hardware platforms
2323
For Python-only distributions, it *should* be straightforward to deploy on all
2424
platforms where Python can run.
2525

26-
For distributions with binary extensions, deployment is major headache. Not only
26+
For distributions with binary extensions, deployment is a major headache. Not only
2727
must the extensions be built on all the combinations of operating system and
2828
hardware platform, but they must also be tested, preferably on continuous
2929
integration platforms. The issues are similar to the "multiple Python

source/discussions/pip-vs-easy-install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It was notable at the time for installing :term:`packages <Distribution Package>
1111
:term:`PyPI <Python Package Index (PyPI)>` using requirement specifiers, and
1212
automatically installing dependencies.
1313

14-
:ref:`pip` came later in 2008, as alternative to :ref:`easy_install <easy_install>`, although still
14+
:ref:`pip` came later in 2008, as an alternative to :ref:`easy_install <easy_install>`, although still
1515
largely built on top of :ref:`setuptools` components. It was notable at the
1616
time for *not* installing packages as :term:`Eggs <Egg>` or from :term:`Eggs <Egg>` (but
1717
rather simply as 'flat' packages from :term:`sdists <Source Distribution (or

source/discussions/versioning.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ semantic versioning and calendar versioning.
7575
number. The maintainers may consciously choose to break the
7676
assumption that the last version segment only contains
7777
backwards-compatible changes.
78-
One such case is when security vulnerability needs to be
78+
One such case is when a security vulnerability needs to be
7979
addressed. Security releases often come in patch versions
8080
but contain breaking changes inevitably.
8181

@@ -124,7 +124,7 @@ Calendar versioning
124124
-------------------
125125

126126
Semantic versioning is not a suitable choice for all projects, such as those
127-
with a regular time based release cadence and a deprecation process that
127+
with a regular time-based release cadence and a deprecation process that
128128
provides warnings for a number of releases prior to removal of a feature.
129129

130130
A key advantage of date-based versioning, or `calendar versioning <calver_>`_
@@ -148,7 +148,7 @@ user, as serial version numbers convey little or no information regarding API
148148
backwards compatibility.
149149

150150
Combinations of the above schemes are possible. For example, a project may
151-
combine date based versioning with serial versioning to create a *year.serial*
151+
combine date-based versioning with serial versioning to create a *year.serial*
152152
numbering scheme that readily conveys the approximate age of a release, but
153153
doesn't otherwise commit to a particular release cadence within the year.
154154

source/guides/creating-command-line-tools.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Creating and packaging command-line tools
55
=========================================
66

77
This guide will walk you through creating and packaging a standalone command-line application
8-
that can be installed with :ref:`pipx`, a tool creating and managing :term:`Python Virtual Environments <Virtual Environment>`
8+
that can be installed with :ref:`pipx`, a tool for creating and managing :term:`Python Virtual Environments <Virtual Environment>`
99
and exposing the executable scripts of packages (and available manual pages) for use on the command-line.
1010

1111
Creating the package
@@ -98,7 +98,7 @@ Now, add an empty :file:`__init__.py` file, to define the project as a regular :
9898

9999
The file :file:`__main__.py` marks the main entry point for the application when running it via :mod:`runpy`
100100
(i.e. ``python -m greetings``, which works immediately with flat layout, but requires installation of the package with src layout),
101-
so initizalize the command-line interface here:
101+
so initialize the command-line interface here:
102102

103103
.. code-block:: python
104104
@@ -162,7 +162,7 @@ To just run the program without installing it permanently, use ``pipx run``, whi
162162
163163
$ pipx run --spec . greet --knight
164164
165-
This syntax is a bit unpractical, however; as the name of the entry point we defined above does not match the package name,
165+
This syntax is a bit impractical, however; as the name of the entry point we defined above does not match the package name,
166166
we need to state explicitly which executable script to run (even though there is only on in existence).
167167

168168
There is, however, a more practical solution to this problem, in the form of an entry point specific to ``pipx run``.

source/guides/installing-using-pip-and-virtual-environments.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ When your virtual environment is activated, you can install packages. Use the
200200
Install a package
201201
~~~~~~~~~~~~~~~~~
202202

203-
For example,let's install the
203+
For example, let's install the
204204
`Requests`_ library from the :term:`Python Package Index (PyPI)`:
205205

206206
.. tab:: Unix/macOS

source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ topics.
7979
Explanations and Discussions
8080
============================
8181

82-
The :doc:`discussions/index` section for in-depth explanations and discussion
82+
The :doc:`discussions/index` section provides in-depth explanations and discussion
8383
about topics, such as:
8484

8585
* :doc:`discussions/deploying-python-applications`

source/specifications/source-distribution-format.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Source distribution format
66
==========================
77

8-
The current standard format of source distribution format is identified by the
8+
The current standard source distribution format is identified by the
99
presence of a :file:`pyproject.toml` file in the distribution archive. The layout
1010
of such a distribution was originally specified in :pep:`517` and is formally
1111
documented here.
@@ -27,7 +27,7 @@ Source trees
2727

2828
A *source tree* is a collection of files and directories -- like a version
2929
control system checkout -- which contains a :file:`pyproject.toml` file that
30-
can be use to build a source distribution from the contained files and
30+
can be used to build a source distribution from the contained files and
3131
directories. :pep:`517` and :pep:`518` specify what is required to meet the
3232
definition of what :file:`pyproject.toml` must contain for something to be
3333
deemed a source tree.

source/specifications/version-specifiers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ part of the ``3.3`` release series.
226226
form to ``X.Y.0`` when comparing it to any release segment that includes
227227
three components.
228228

229-
Date based release segments are also permitted. An example of a date based
229+
Date-based release segments are also permitted. An example of a date-based
230230
release scheme using the year and month of the release::
231231

232232
2012.4

0 commit comments

Comments
 (0)