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.

Sign up for GitHub

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

Jump to bottom

[Docs] Clarify version number conventions wrt PEP440 #3419

Closed
1 task done
cdfarrow opened this issue Jun 28, 2022 · 0 comments · Fixed by #3628
Closed
1 task done

[Docs] Clarify version number conventions wrt PEP440 #3419

cdfarrow opened this issue Jun 28, 2022 · 0 comments · Fixed by #3628
Labels
documentation Needs Triage Issues that need to be evaluated for severity and status.

Comments

@cdfarrow
Copy link
Contributor

Summary

The setuptools' Version page gives a lot of example schemes that are not PEP440 compliant. I followed that page to create a post-release version number, but then it was rejected by PyPI. The page mentions PEP440 in passing in the opening paragraph, but it would be more helpful to explain that for certain situations (e.g. uploading to PyPI; what else?) PEP440 must be followed.

OS / Environment

No response

Additional Information

This would direct readers straight to the correct/recommended conventions rather than wasting their time reading irrelevant information.

Code of Conduct

  • I agree to follow the PSF Code of Conduct
@cdfarrow cdfarrow added documentation Needs Triage Issues that need to be evaluated for severity and status. labels Jun 28, 2022
veatch added a commit to veatch/setuptools that referenced this issue Oct 6, 2022
@veatch
Fix pypa#3419. Update example versions to be PEP440-compliant
0d2bcd8
@veatch veatch mentioned this issue Oct 6, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Needs Triage Issues that need to be evaluated for severity and status.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update user guide's example versions to be PEP440-compliant veatch/setuptools
1 participant
@cdfarrow