Correct docs on how to use the legacy-editable mode (#3538)

pypa · Aug 17, 2022 · fe8a98e · fe8a98e
2 parents 23d455c + aa83713
commit fe8a98e
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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]_.