From fc205302117c59f10ea61e81aea5ff546ddf757f Mon Sep 17 00:00:00 2001 From: Jim Garrison Date: Fri, 29 Apr 2022 04:24:50 -0400 Subject: [PATCH] Clarify that `pyproject.toml` config will not be removed The current documentation regarding `pyproject.toml` claims that support for using it to specify package metadata and build configuration options might be "completely removed" in a future release. However, nowadays it is clear (https://github.com/pypa/setuptools/issues/1688#issuecomment-1079706929 and #3214) that `pyproject.toml` is not going anywhere, is here to stay, and is in fact expected to be the preferred format in the future. This makes an incremental change toward that future by clarifying that `pyproject.toml` support will not be removed in a future release of setuptools. --- docs/userguide/dependency_management.rst | 2 +- docs/userguide/package_discovery.rst | 4 ++-- docs/userguide/pyproject_config.rst | 2 +- docs/userguide/quickstart.rst | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/userguide/dependency_management.rst b/docs/userguide/dependency_management.rst index d15b45cb6e..d507a587fe 100644 --- a/docs/userguide/dependency_management.rst +++ b/docs/userguide/dependency_management.rst @@ -439,5 +439,5 @@ This can be configured as shown in the example below. While the ``[build-system]`` table should always be specified in the ``pyproject.toml`` file, support for adding package metadata and build configuration options via the ``[project]`` and ``[tool.setuptools]`` tables is still - experimental and might change (or be completely removed) in future releases. + experimental and might change in future releases. See :doc:`/userguide/pyproject_config`. diff --git a/docs/userguide/package_discovery.rst b/docs/userguide/package_discovery.rst index 38119bc6fa..c6ab2a77ae 100644 --- a/docs/userguide/package_discovery.rst +++ b/docs/userguide/package_discovery.rst @@ -567,8 +567,8 @@ The project layout remains the same and ``setup.cfg`` remains the same. .. [#experimental] Support for specifying package metadata and build configuration options via - ``pyproject.toml`` is experimental and might change (or be completely - removed) in the future. See :doc:`/userguide/pyproject_config`. + ``pyproject.toml`` is experimental and might change + in the future. See :doc:`/userguide/pyproject_config`. .. [#layout1] https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure .. [#layout2] https://blog.ionelmc.ro/2017/09/25/rehashing-the-src-layout/ diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index 47c4511ebb..7b8f8104fe 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -10,7 +10,7 @@ Configuring setuptools using ``pyproject.toml`` files Support for declaring :doc:`project metadata ` or configuring ``setuptools`` via ``pyproject.toml`` files is still experimental and might - change (or be removed) in future releases. + change in future releases. .. important:: For the time being, ``pip`` still might require a ``setup.py`` file diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 2f77852178..14e607d450 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -410,5 +410,5 @@ up-to-date references that can help you when it is time to distribute your work. While the ``[build-system]`` table should always be specified in the ``pyproject.toml`` file, support for adding package metadata and build configuration options via the ``[project]`` and ``[tool.setuptools]`` tables is still - experimental and might change (or be completely removed) in future releases. + experimental and might change in future releases. See :doc:`/userguide/pyproject_config`.