Skip to content

Commit 000efbf

Browse files
committed
docs: Add a note about historical wheel use in requires (#3859)
2 parents 2476f2f + 1ba53bb commit 000efbf

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

changelog.d/3859.doc.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Added a note about historical presence of ``wheel``
2+
in ``build-system.requires``, in ``pyproject.toml``.

docs/userguide/quickstart.rst

+11
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,17 @@ containing a ``build-system`` section similar to the example below:
5656
This section declares what are your build system dependencies, and which
5757
library will be used to actually do the packaging.
5858

59+
.. note::
60+
61+
Historically this documentation has unnecessarily listed ``wheel``
62+
in the ``requires`` list, and many projects still do that. This is
63+
not recommended. The backend automatically adds ``wheel`` dependency
64+
when it is required, and listing it explicitly causes it to be
65+
unnecessarily required for source distribution builds.
66+
You should only include ``wheel`` in ``requires`` if you need to explicitly
67+
access it during build time (e.g. if your project needs a ``setup.py``
68+
script that imports ``wheel``).
69+
5970
In addition to specifying a build system, you also will need to add
6071
some package information such as metadata, contents, dependencies, etc.
6172
This can be done in the same ``pyproject.toml`` [#beta]_ file,

0 commit comments

Comments
 (0)