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

Improve example docs for setup.cfg and pyproject.toml #3712

Merged
merged 1 commit into from
Jan 11, 2023

Conversation

mwtoews
Copy link
Contributor

@mwtoews mwtoews commented Nov 26, 2022

This PR improves the example documentation for both setup.cfg and pyproject.toml.

Changes to both examples:

  • Add an author and email, as these are commonly used (an alternative fictional person could be nominated, if a better one exists)
  • Use the SPDX short identifier BSD-3-Clause, which aligns with PEP 639

Other:

  • With setup.py only, add python_requires to example, so that it is compatible to pyproject.toml

@abravalheri
Copy link
Contributor

Thank you @mwtoews.

My understanding is that, so far, the license text is free form. Once PEP 639 is approved, then there will be a separated field for them... Nevertheless it should not hurt to have SPDX in the examples (as long as users don't expect it to work before PEP 639 is implemented/with the wrong fields).

@jaraco jaraco force-pushed the main branch 3 times, most recently from a85759c to 93ce5a0 Compare December 16, 2022 18:21
@abravalheri abravalheri merged commit ea531c1 into pypa:main Jan 11, 2023
@mwtoews mwtoews deleted the improve-examples branch January 11, 2023 19:03
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.

2 participants