diff options
author | Ed Morley <501702+edmorley@users.noreply.github.com> | 2022-08-17 17:37:40 +0100 |
---|---|---|
committer | Ed Morley <501702+edmorley@users.noreply.github.com> | 2022-08-17 17:37:40 +0100 |
commit | aa837138ce15d08af554452a3884ba1f799600da (patch) | |
tree | 6c3ce352cdac2c2e60ed167a688440ff07fe53c6 | |
parent | 23d455c532fca91e6f00aa5950000739b058b6e5 (diff) | |
download | python-setuptools-git-aa837138ce15d08af554452a3884ba1f799600da.tar.gz |
Correct docs on how to use the `legacy-editable` mode
PR #3414 added support for disabling the new PEP660 editable install
hooks. However the documentation and changelog mentions didn't
match the implementation.
Before:
- The implementation used: `SETUPTOOLS_ENABLE_FEATURES`
- The changelog said to use: `SETUPTOOLS_ENABLE_FEATURE`
(notice the missing "S")
- The docs said to use: `SETUPTOOLS_USE_FEATURE`
This caused confusion in #3535, since the testcase there used the form
mentioned in the changelog, which doesn't do anything.
Now, the changelog and docs both say to use `SETUPTOOLS_ENABLE_FEATURES`.
-rw-r--r-- | CHANGES.rst | 2 | ||||
-rw-r--r-- | changelog.d/3538.doc.rst | 1 | ||||
-rw-r--r-- | docs/userguide/development_mode.rst | 2 |
3 files changed, 3 insertions, 2 deletions
diff --git a/CHANGES.rst b/CHANGES.rst index 69769ae3..1021030e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -143,7 +143,7 @@ Changes ``sdist``. This allows plugins and customization scripts to automatically add required source files in the source distribution. * #3414: Users can *temporarily* specify an environment variable - ``SETUPTOOLS_ENABLE_FEATURE=legacy-editable`` as a escape hatch for the + ``SETUPTOOLS_ENABLE_FEATURES=legacy-editable`` as a escape hatch for the :pep:`660` behavior. This setting is **transitional** and may be removed in the future. * #3484: Added *transient* ``compat`` mode to editable installs. diff --git a/changelog.d/3538.doc.rst b/changelog.d/3538.doc.rst new file mode 100644 index 00000000..ff82dffb --- /dev/null +++ b/changelog.d/3538.doc.rst @@ -0,0 +1 @@ +Corrected documentation on how to use the `legacy-editable` mode. diff --git a/docs/userguide/development_mode.rst b/docs/userguide/development_mode.rst index c911af53..a421999b 100644 --- a/docs/userguide/development_mode.rst +++ b/docs/userguide/development_mode.rst @@ -194,7 +194,7 @@ variable: .. code-block:: - SETUPTOOLS_USE_FEATURE="legacy-editable" + SETUPTOOLS_ENABLE_FEATURES="legacy-editable" This *may* cause the installer (e.g. ``pip``) to effectively run the "legacy" installation command: ``python setup.py develop`` [#installer]_. |