Skip to content

Commit b57cced

Browse files
committed
Reword docs on 'Build system requirement' to use imperative voice.
1 parent 441799f commit b57cced

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/userguide/dependency_management.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,25 @@ Build system requirement
1818
========================
1919

2020
After organizing all the scripts and files and getting ready for packaging,
21-
there needs to be a way to specify what programs and libraries are actually needed
22-
to do the packaging (in our case, ``setuptools`` of course).
23-
This needs to be specified in your ``pyproject.toml`` file
24-
(if you have forgot what this is, go to :doc:`/userguide/quickstart` or :doc:`/build_meta`):
21+
there needs to be a way to specify what programs and libraries (build backend)
22+
are actually needed to build the package for distribution. For Setuptools, the
23+
requisite library is ``setuptools``. Specify the build backend in a
24+
``pyproject.toml`` file (see also :doc:`/userguide/quickstart` or
25+
:doc:`/build_meta`):
2526

2627
.. code-block:: toml
2728
2829
[build-system]
2930
requires = ["setuptools"]
3031
#...
3132
32-
Please note that you should also include here any other ``setuptools`` plugin
33-
(e.g., :pypi:`setuptools-scm`, :pypi:`setuptools-golang`, :pypi:`setuptools-rust`)
33+
Please note also to include any other ``setuptools`` plugins
34+
(e.g., :pypi:`setuptools_scm`, :pypi:`setuptools-golang`, :pypi:`setuptools-rust`)
3435
or build-time dependency (e.g., :pypi:`Cython`, :pypi:`cppy`, :pypi:`pybind11`).
3536

3637
.. note::
3738
In previous versions of ``setuptools``,
38-
this used to be accomplished with the ``setup_requires`` keyword but is
39+
the ``setup_requires`` keyword performed a similar function but is
3940
now considered deprecated in favor of the :pep:`517` style described above.
4041
To peek into how this legacy keyword is used, consult our :doc:`guide on
4142
deprecated practice (WIP) </deprecated/index>`.

0 commit comments

Comments
 (0)