-
Notifications
You must be signed in to change notification settings - Fork 72
docs: clarify PyPI distribution type requirements #552
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the language around PyPI distribution file requirements to clarify that PyPI supports rather than requires source and wheel files. Translation files for Japanese and Spanish have been updated to match.
- Replaced “PyPI requires” with “PyPI supports” in the English tutorial
- Updated corresponding
.po
entries in Japanese and Spanish locales - (Translator testing follow-up may be needed to verify spacing)
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
File | Description |
---|---|
tutorials/intro.md | Changed “requires” to “supports” for sdists and wheels |
locales/ja/LC_MESSAGES/tutorials.po | Adjusted source string to match updated English text |
locales/es/LC_MESSAGES/tutorials.po | Adjusted source string to match updated English text |
Comments suppressed due to low confidence (2)
locales/ja/LC_MESSAGES/tutorials.po:3689
- The string literal in the Japanese .po file is missing a leading space before "and", causing "[sdist]and" when concatenated. Add a space (e.g., change to " and [wheel]") or merge it into the previous literal, then rebuild the docs to verify the translation.
and [wheel](#python-wheel) files. Once you are ready to make your code publicly "
locales/es/LC_MESSAGES/tutorials.po:3294
- The string literal in the Spanish .po file is missing a leading space before "and", causing "[sdist]and" when concatenated. Add a space (e.g., change to " and [wheel]") or merge it into the previous literal, then rebuild the docs to verify the translation.
and [wheel](#python-wheel) files. Once you are ready to make your code publicly "
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @jameslamb this is a really good (and important) fix! I'm glad you caught that.
let's merge this! it is an important update / fix and looks good. The po file updates also look aligned with the changes. |
https://www.pyopensci.org/python-package-guide/tutorials/intro.html#publishing-a-package-to-pypi-conda-forge says
pypi.org
requires both sdists and wheels.That isn't true. For example,
torch
has only wheels.ref: https://pypi.org/project/torch/#files
This proposes updating that language to refer only to file types that PyPI supports.
Notes for Reviewers
I haven't worked with translation files (
.po
) before so did a very naive update to those that contained this same text. Please let me know if there's a way I can test those changes.