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

Update user guide's example versions to be PEP440-compliant #3628

Merged
merged 3 commits into from Oct 11, 2022

Conversation

veatch
Copy link
Contributor

@veatch veatch commented Oct 6, 2022

Summary of changes

Updated example versions on the Specifying Your Project’s Version page to be PEP440-compliant.

I used the is_canonical function from PEP-440 Appendix B to verify that new version strings are compliant.

Closes #3419.

Pull Request Checklist

@pradyunsg
Copy link
Member

I used the is_canonical function from PEP-440 Appendix B to verify that new version strings are compliant.

FWIW, you could use https://packaging.pypa.io/en/latest/utils.html#packaging.utils.canonicalize_version to check this as well (and, it's likely a more pragmatic source of truth as of today).

Copy link
Contributor

@abravalheri abravalheri left a comment

Choose a reason for hiding this comment

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

Thank you very much @veatch for the update.

docs/userguide/distribution.rst Outdated Show resolved Hide resolved
Thanks @abravalheri for this change!

Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
@abravalheri abravalheri merged commit 9f5eeab into pypa:main Oct 11, 2022
@abravalheri
Copy link
Contributor

Thanks @veatch ❤️ 💚 💛 💜

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.

[Docs] Clarify version number conventions wrt PEP440
3 participants