Skip to content

Commit 22bbb69

Browse files
Fix documentation grammar, typos, and clarity issues
- Fix typo: "becauset" → "because" in interfaces.rst - Fix grammar: "help installer" → "help installers" in index.rst - Fix phrase: "Most of the times" → "Most of the time" in quickstart.rst - Fix capitalization: "python" → "Python" in quickstart.rst - Fix word order: "that not necessarily should be" → "that should not necessarily be" in quickstart.rst - Fix grammar: "content type is used" → "content type used" in keywords.rst - Fix duplicate word: "are are" → "are" in easy_install.rst - Fix subject-verb: "aggregate" → "aggregates" in pyproject_config.rst - Fix plural: "practice" → "practices" in deprecated/index.rst - Fix glob pattern: "AUTHORS**" → "AUTHORS*" in miscellaneous.rst Co-authored-by: DimitriPapadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
1 parent 7065935 commit 22bbb69

File tree

8 files changed

+10
-10
lines changed

8 files changed

+10
-10
lines changed

docs/deprecated/easy_install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ You will need at least Python 3.5 or 2.7. An ``easy_install`` script will be
4242
installed in the normal location for Python scripts on your platform.
4343

4444
Note that the instructions on the setuptools PyPI page assume that you are
45-
are installing to Python's primary ``site-packages`` directory. If this is
45+
installing to Python's primary ``site-packages`` directory. If this is
4646
not the case, you should consult the section below on `Custom Installation
4747
Locations`_ before installing. (And, on Windows, you should not use the
4848
``.exe`` installer when installing to an alternate location.)

docs/deprecated/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Guides on backward compatibility & deprecated practice
33
======================================================
44

55
``Setuptools`` has undergone tremendous changes since its first debut. As its
6-
development continues to roll forward, many of the practice and mechanisms it
6+
development continues to roll forward, many of the practices and mechanisms it
77
had established are now considered deprecated. But they still remain relevant
88
as a plethora of libraries continue to depend on them. Many people also find
99
it necessary to equip themselves with the knowledge to better support backward

docs/references/keywords.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ extensions).
5454
.. _keyword/long_description_content_type:
5555

5656
``long_description_content_type``
57-
A string specifying the content type is used for the ``long_description``
57+
A string specifying the content type used for the ``long_description``
5858
(e.g. ``text/markdown``)
5959

6060
.. _keyword/author:

docs/userguide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The first step towards sharing a Python library or program is to build a
66
distribution package [#package-overload]_. This includes adding a set of
77
additional files containing metadata and configuration to not only instruct
88
``setuptools`` on how the distribution should be built but also
9-
to help installer (such as :pypi:`pip`) during the installation process.
9+
to help installers (such as :pypi:`pip`) during the installation process.
1010

1111
This document contains information to help Python developers through this
1212
process. Please check the :doc:`/userguide/quickstart` for an overview of

docs/userguide/interfaces.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ carefully attempt to find alternatives before resorting to unscheduled removals.
5454
In the context of ``setuptools``, the introduction of :py:mod:`warnings`
5555
(including deprecation warnings) is not considered a breaking change *per se*.
5656
Instead it is considered a backwards compatible *communication action* that
57-
precedes an upcoming breaking change. This is becauset code
57+
precedes an upcoming breaking change. This is because code
5858
containing warnings typically does not fail and can successfully terminate
5959
execution, unless users explicitly opt into transforming those warnings
6060
into errors (e.g., via Python's :external+python:ref:`-W option or

docs/userguide/miscellaneous.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ files are included in a source distribution by default:
2424
in ``pyproject.toml`` and/or equivalent in ``setup.cfg``/``setup.py``;
2525
note that if you don't explicitly set this parameter, ``setuptools``
2626
will include any files that match the following glob patterns:
27-
``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, ``AUTHORS**``;
27+
``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, ``AUTHORS*``;
2828
- ``pyproject.toml``;
2929
- ``setup.cfg``;
3030
- ``setup.py``;

docs/userguide/pyproject_config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ existing packages should consider migrating to alternatives.
170170
packages = ["my_package"]
171171
172172
If you want to publish a distribution that does not include any Python module
173-
(e.g. a "meta-distribution" that just aggregate dependencies), please
173+
(e.g. a "meta-distribution" that just aggregates dependencies), please
174174
consider something like the following:
175175

176176
.. code-block:: toml

docs/userguide/quickstart.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can install the latest version of ``setuptools`` using :pypi:`pip`::
99

1010
pip install --upgrade setuptools[core]
1111

12-
Most of the times, however, you don't have to...
12+
Most of the time, however, you don't have to...
1313

1414
Instead, when creating new Python packages, it is recommended to use
1515
a command line tool called :pypi:`build`. This tool will automatically download
@@ -33,7 +33,7 @@ This will allow you to run the command: ``python -m build``.
3333
check out :doc:`pip installation docs <pip:installation>`.
3434

3535

36-
Every python package must provide a ``pyproject.toml`` and specify
36+
Every Python package must provide a ``pyproject.toml`` and specify
3737
the backend (build system) it wants to use. The distribution can then
3838
be generated with whatever tool that provides a ``build sdist``-like
3939
functionality.
@@ -200,7 +200,7 @@ Package discovery
200200
For projects that follow a simple directory structure, ``setuptools`` should be
201201
able to automatically detect all :term:`packages <package>` and
202202
:term:`namespaces <namespace package>`. However, complex projects might include
203-
additional folders and supporting files that not necessarily should be
203+
additional folders and supporting files that should not necessarily be
204204
distributed (or that can confuse ``setuptools`` auto discovery algorithm).
205205

206206
Therefore, ``setuptools`` provides a convenient way to customize

0 commit comments

Comments
 (0)