Add a warning to "Fallback behavior" doc snippet #12122
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
uranusjr
reviewed
Jul 3, 2023
Add a warning noting that the "Fallback behavior" doc snippet does not provide a good example of what projects put in `pyproject.toml` and instead link to the respective setuptools documentation. In my experience, more than one project has either copied the snippets verbatim, or incorrectly included `wheel` in their `requires` based on it.
uranusjr
approved these changes
Jul 4, 2023
ichard26
approved these changes
Apr 20, 2024
pfmoore
approved these changes
Apr 20, 2024
There was a problem hiding this comment.
I'm not sure this will make much difference - people tend to copy snippets without really checking that they are appropriate, regardless of what the text around them says, in my experience. But it's a clear improvement over what's there currently, so there's no reason not to add it.
|
Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a warning noting that the "Fallback behavior" doc snippet does not provide a good example of what projects put in
pyproject.tomland instead link to the respective setuptools documentation.In my experience, more than one project has either copied the snippets verbatim, or incorrectly included
wheelin theirrequiresbased on it.