Skip to content

Commit 5c54112

Browse files
authored
Merge pull request #1593 from hutcho/patch-1
Clarified note on [build-system] and [project]
2 parents 7e06fb2 + d93dca3 commit 5c54112

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

source/guides/writing-pyproject-toml.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ three possible TOML tables in this file.
2222

2323
.. note::
2424

25-
There is a significant difference between the ``[build-system]`` and
26-
``[project]`` tables. The former should always be present, regardless of
27-
which build backend you use (since it *defines* the tool you use). The latter
28-
is understood by *most* build backends, but some build backends use a
29-
different format.
25+
The ``[build-system]`` table should always be present,
26+
regardless of which build backend you use (``[build-system]`` *defines* the
27+
build tool you use).
3028

31-
At the time of writing this (November 2023), Poetry_ is a notable build
32-
backend that does not use the ``[project]`` table (it uses the
33-
``[tool.poetry]`` table instead).
29+
On the other hand, the ``[project]`` table is understood by *most* build
30+
backends, but some build backends use a different format.
3431

32+
As of August 2024, Poetry_ is a notable build backend that does not use
33+
the ``[project]`` table, it uses the ``[tool.poetry]`` table instead.
3534
Also, the setuptools_ build backend supports both the ``[project]`` table,
36-
and the older format in ``setup.cfg`` or ``setup.py``. For new projects, it
37-
is recommended to use the ``[project]`` table, and keep ``setup.py`` only if
35+
and the older format in ``setup.cfg`` or ``setup.py``.
36+
37+
For new projects, use the ``[project]`` table, and keep ``setup.py`` only if
3838
some programmatic configuration is needed (such as building C extensions),
3939
but the ``setup.cfg`` and ``setup.py`` formats are still valid. See
4040
:ref:`setup-py-deprecated`.

0 commit comments

Comments
 (0)