From aa837138ce15d08af554452a3884ba1f799600da Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Wed, 17 Aug 2022 17:37:40 +0100 Subject: 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`. --- docs/userguide/development_mode.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/userguide') 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]_. -- cgit v1.2.1