Skip to content

Comments

Fix documentation: grammar, typos, formatting, and links#678

Merged
agronholm merged 2 commits intopypa:mainfrom
DimitriPapadopoulos:doc
Feb 8, 2026
Merged

Fix documentation: grammar, typos, formatting, and links#678
agronholm merged 2 commits intopypa:mainfrom
DimitriPapadopoulos:doc

Conversation

@DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented Feb 8, 2026

Should both roles remain documented?

wheel/docs/index.rst

Lines 12 to 19 in 8b6fa74

It has two different roles:
#. A setuptools_ extension for building wheels that provides the
``bdist_wheel`` setuptools command
#. A command line tool for working with wheel files
.. _PEP 427: https://www.python.org/dev/peps/pep-0427/
.. _setuptools: https://pypi.org/project/setuptools/

The README has been updated so the documentation seems inconsistent:

wheel/README.rst

Lines 14 to 20 in 8b6fa74

Historical note
---------------
This project used to contain the implementation of the setuptools_ ``bdist_wheel``
command, but as of setuptools v70.1, it no longer needs ``wheel`` installed for that to
work. Thus, you should install this **only** if you intend to use the ``wheel`` command
line tool!

Co-authored-by: DimitriPapadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Feb 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.63%. Comparing base (8b6fa74) to head (f09b855).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #678   +/-   ##
=======================================
  Coverage   52.63%   52.63%           
=======================================
  Files          14       14           
  Lines        1121     1121           
=======================================
  Hits          590      590           
  Misses        531      531           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@agronholm
Copy link
Contributor

Looks good so far. Do you plan to add more commits to this?

@DimitriPapadopoulos
Copy link
Contributor Author

I only have a question about the documenting role of wheel as a setuptools extension.

@DimitriPapadopoulos DimitriPapadopoulos marked this pull request as ready for review February 8, 2026 12:14
@agronholm
Copy link
Contributor

In 2024 I pushed a change to setuptools that vendors wheel, making this project unnecessary to be installed in order to build wheels. I even published some versions of wheel that got rid of the bdist_wheel command entirely, but had to back out of that as there were many projects out there that for some bizarre reason wanted to update wheel but not setuptools, causing the bdist_wheel command to not work at all. But I don't want to even hint at the existence of bdist_wheel here, as many developers are poor at reading the documentation properly and will jump to the wrong conclusions, based on my real-world experience.

@DimitriPapadopoulos
Copy link
Contributor Author

DimitriPapadopoulos commented Feb 8, 2026

Thank you. Then I understand the two roles should remain here:

wheel/docs/index.rst

Lines 12 to 19 in 8b6fa74

It has two different roles:
#. A setuptools_ extension for building wheels that provides the
``bdist_wheel`` setuptools command
#. A command line tool for working with wheel files
.. _PEP 427: https://www.python.org/dev/peps/pep-0427/
.. _setuptools: https://pypi.org/project/setuptools/

@agronholm
Copy link
Contributor

Actually, I had forgotten about that documentation page altogether. I don't want to advertise wheel as a setuptools extension, as it should no longer be used in that manner. The index page should probably be rewritten.

Copy link
Contributor

@agronholm agronholm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I'll make some modifications on my own but I won't bother you with those. Thanks!

@agronholm agronholm merged commit ad932ee into pypa:main Feb 8, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants