Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged

Conversation

edmorley
Copy link
Contributor

Summary of changes

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.

Pull Request Checklist

  • Changes have tests
  • News fragment added in [changelog.d/].

PR pypa#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 pypa#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`.
@abravalheri
Copy link
Contributor

Sorry for the inconvenience and thank you very much for the fix.

@abravalheri abravalheri merged commit fe8a98e into pypa:main Aug 17, 2022
@edmorley edmorley deleted the correct-SETUPTOOLS_ENABLE_FEATURES-name branch August 17, 2022 16:52
@edmorley
Copy link
Contributor Author

No trouble! :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants