Skip to content

Commit

Permalink
Correct docs on how to use the legacy-editable mode
Browse files Browse the repository at this point in the history
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`.
  • Loading branch information
edmorley committed Aug 17, 2022
1 parent 23d455c commit aa83713
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions changelog.d/3538.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Corrected documentation on how to use the `legacy-editable` mode.
2 changes: 1 addition & 1 deletion docs/userguide/development_mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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]_.
Expand Down

0 comments on commit aa83713

Please sign in to comment.