Skip to content

Commit ad932ee

Browse files
Fix documentation: grammar, typos, formatting, and links (#678)
1 parent 8b6fa74 commit ad932ee

11 files changed

Lines changed: 20 additions & 30 deletions

File tree

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This is a command line tool for manipulating Python wheel files, as defined in
99
* Repack wheel archives
1010
* Add or remove tags in existing wheel archives
1111

12-
.. _PEP 427: https://www.python.org/dev/peps/pep-0427/
12+
.. _PEP 427: https://peps.python.org/pep-0427/
1313

1414
Historical note
1515
---------------

docs/development.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Pull Requests
88
- Provide a good description of what you're doing and why.
99
- Provide tests that cover your changes and try to run the tests locally first.
1010

11-
**Example**. Assuming you set up GitHub account, forked wheel repository from
11+
**Example**. Assuming you set up a GitHub account, forked the wheel repository from
1212
https://github.com/pypa/wheel to your own page via web interface, and your
1313
fork is located at https://github.com/yourname/wheel
1414

@@ -23,7 +23,7 @@ fork is located at https://github.com/yourname/wheel
2323
$ git commit
2424

2525
You may reference relevant issues in commit messages (like #1259) to
26-
make GitHub link issues and commits together, and with phrase like
26+
make GitHub link issues and commits together, and with a phrase like
2727
"fixes #1259" you can even close relevant issues automatically. Now
2828
push the changes to your fork::
2929

@@ -54,7 +54,7 @@ To run the tests via tox against all matching interpreters::
5454

5555
To run the tests via tox against a specific environment::
5656

57-
$ tox -e py35
57+
$ tox -e py39
5858

5959
Alternatively, you can run the tests via pytest using your default interpreter::
6060

@@ -92,5 +92,5 @@ To make a new release:
9292
#. Create a new git tag matching the version exactly
9393
#. Push the new tag to GitHub
9494

95-
Pushing a new tag to GitHub will trigger the publish workflow which package the
95+
Pushing a new tag to GitHub will trigger the publish workflow which will package the
9696
project and publish the resulting artifacts to PyPI.

docs/index.rst

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,7 @@ wheel
66
User IRC: #pypa |
77
Dev IRC: #pypa-dev
88

9-
This library is the reference implementation of the Python wheel packaging
10-
standard, as defined in `PEP 427`_.
11-
12-
It has two different roles:
13-
14-
#. A setuptools_ extension for building wheels that provides the
15-
``bdist_wheel`` setuptools command
16-
#. A command line tool for working with wheel files
17-
18-
.. _PEP 427: https://www.python.org/dev/peps/pep-0427/
19-
.. _setuptools: https://pypi.org/project/setuptools/
9+
This library primarily serves as a command line tool for working with wheel files.
2010

2111
.. toctree::
2212
:maxdepth: 2

docs/installing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ can typically find the wheel package under one of the following package names:
1515
* python3-wheel
1616

1717
.. _pip: https://pip.pypa.io/en/stable/
18-
.. _installation instructions: https://pip.pypa.io/en/stable/installing/
18+
.. _installation instructions: https://pip.pypa.io/en/stable/installation/
1919

2020
Python and OS Compatibility
2121
---------------------------

docs/manpages/wheel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ Options
4343
-h, --help show this help message and exit
4444

4545

46-
.. _`PEP 427`: https://www.python.org/dev/peps/pep-0427/
46+
.. _`PEP 427`: https://peps.python.org/pep-0427/

docs/news.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Release Notes
4747
``setuptools.command.bdist_wheel.bdist_wheel`` to improve compatibility with
4848
``setuptools``' latest fixes.
4949

50-
Projects are still advised to migrate away from the deprecated module and import
50+
Projects are still advised to migrate away from the deprecated module and import
5151
the ``setuptools``' implementation explicitly. (PR by @abravalheri)
5252

5353
**0.44.0 (2024-08-04)**
@@ -127,7 +127,7 @@ Release Notes
127127
**0.38.1 (2022-11-04)**
128128

129129
- Removed install dependency on setuptools
130-
- The future-proof fix in 0.36.0 for converting PyPy's SOABI into a abi tag was
130+
- The future-proof fix in 0.36.0 for converting PyPy's SOABI into an ABI tag was
131131
faulty. Fixed so that future changes in the SOABI will not change the tag.
132132

133133
**0.38.0 (2022-10-21)**
@@ -175,7 +175,7 @@ Release Notes
175175
- Updated vendored ``packaging`` library to v20.7
176176
- Switched to always using LF as line separator when generating ``WHEEL`` files
177177
(on Windows, CRLF was being used instead)
178-
- The ABI tag is taken from the sysconfig SOABI value. On PyPy the SOABI value
178+
- The ABI tag is taken from the sysconfig SOABI value. On PyPy the SOABI value
179179
is ``pypy37-pp73`` which is not compliant with PEP 3149, as it should have
180180
both the API tag and the platform tag. This change future-proofs any change
181181
in PyPy's SOABI tag to make sure only the ABI tag is used by wheel.

docs/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ section to your ``setup.cfg``::
1414
[bdist_wheel]
1515
universal = 1
1616

17-
To convert an ``.egg`` or file to a wheel::
17+
To convert an ``.egg`` file or directory to a wheel::
1818

1919
wheel convert youreggfile.egg
2020

docs/reference/wheel_convert.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ installers (``.exe``; made with ``bdist_wininst``) into wheels.
1717

1818
Egg names must match the standard format:
1919

20-
* ``<project>-<version>-pyX.Y`` for pure Python wheels
21-
* ``<project>-<version>-pyX.Y-<arch>`` for binary wheels
20+
* ``<project>-<version>-pyX.Y`` for pure Python eggs
21+
* ``<project>-<version>-pyX.Y-<arch>`` for binary eggs
2222

2323

2424
Options

docs/reference/wheel_pack.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Options
2828

2929
.. option:: --build-number <tag>
3030

31-
Override the build tag in the new wheel file name
31+
Override the build tag in the new wheel file name.
3232

3333
Examples
3434
--------

docs/reference/wheel_tags.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Description
1212
-----------
1313

1414
Make a new wheel with given tags from an existing wheel. Any tags left
15-
unspecified will remain the same. Multiple tags are separated by a "." Starting
16-
with a "+" will append to the existing tags. Starting with a "-" will remove a
15+
unspecified will remain the same. Multiple tags are separated by a ".". Starting
16+
with a "+" will append to the existing tags. Starting with a "-" will remove a
1717
tag. Be sure to use the equals syntax on the shell so that it does not get
1818
parsed as an extra option, such as ``--python-tag=-py2``. The original file
1919
will remain unless ``--remove`` is given. The output filename(s) will be
@@ -29,12 +29,12 @@ Options
2929

3030
.. option:: --python-tag=TAG
3131

32-
Override the python tag (prepend with "+" to append, "-" to remove).
32+
Override the Python tag (prepend with "+" to append, "-" to remove).
3333
Multiple tags can be separated with a dot.
3434

3535
.. option:: --abi-tag=TAG
3636

37-
Override the abi tag (prepend with "+" to append, "-" to remove).
37+
Override the ABI tag (prepend with "+" to append, "-" to remove).
3838
Multiple tags can be separated with a dot.
3939

4040
.. option:: --platform-tag=TAG

0 commit comments

Comments
 (0)