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

Add a warning to "Fallback behavior" doc snippet #12122

Merged
merged 1 commit into from
Apr 20, 2024

Conversation

mgorny
Copy link
Contributor

@mgorny mgorny commented Jul 2, 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.

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.
Copy link
Member

@ichard26 ichard26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally the setuptools documentation would address when/how to set a minimum version of setuptools, but this is a good change as-is.

Copy link
Member

@pfmoore pfmoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@pfmoore pfmoore merged commit 491846b into pypa:main Apr 20, 2024
3 checks passed
@mgorny mgorny deleted the fallback-warning branch April 20, 2024 18:34
@mgorny
Copy link
Contributor Author

mgorny commented Apr 20, 2024

Thanks!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants