Skip to content

Commit aa83713

Browse files
committed
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`.
1 parent 23d455c commit aa83713

File tree

3 files changed

+3
-2
lines changed

3 files changed

+3
-2
lines changed

CHANGES.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Changes
143143
``sdist``. This allows plugins and customization scripts to automatically
144144
add required source files in the source distribution.
145145
* #3414: Users can *temporarily* specify an environment variable
146-
``SETUPTOOLS_ENABLE_FEATURE=legacy-editable`` as a escape hatch for the
146+
``SETUPTOOLS_ENABLE_FEATURES=legacy-editable`` as a escape hatch for the
147147
:pep:`660` behavior. This setting is **transitional** and may be removed in the
148148
future.
149149
* #3484: Added *transient* ``compat`` mode to editable installs.

changelog.d/3538.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Corrected documentation on how to use the `legacy-editable` mode.

docs/userguide/development_mode.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ variable:
194194

195195
.. code-block::
196196
197-
SETUPTOOLS_USE_FEATURE="legacy-editable"
197+
SETUPTOOLS_ENABLE_FEATURES="legacy-editable"
198198
199199
This *may* cause the installer (e.g. ``pip``) to effectively run the "legacy"
200200
installation command: ``python setup.py develop`` [#installer]_.

0 commit comments

Comments
 (0)