Improve description of check command. #1227
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
sigmavirus24
requested changes
Feb 1, 2025
| added. | ||
|
|
||
| Note: check is not intended to catch all reasons why an upload to PyPI might fail. |
There was a problem hiding this comment.
The docstring doesn't need updating unless I'm mistaken
Comment on lines
+179
to
+184
| description = """ | ||
| This currently only validates ``long_description``, but more checks could be | ||
| added. | ||
|
|
||
| Note: check is not intended to catch all reasons why an upload to PyPI might fail. | ||
| """ |
There was a problem hiding this comment.
Suggested change
| description = """ | |
| This currently only validates ``long_description``, but more checks could be | |
| added. | |
| Note: check is not intended to catch all reasons why an upload to PyPI might fail. | |
| """ | |
| description = """This currently only validates if long_description will render on PyPI. | |
| ** Caution: This does **not** verify everything that PyPI will. | |
| ** Caution: This **never** verifies anything pertinent to non-PyPI index behaviour. | |
| By virtue of performing rendering checks on the long_description, this may validate | |
| other metadata characteristics loosely. | |
| """ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Creating this pull request as proposed in #1152 (comment) by @woodruffw. It modifies the description of the check command such that:
twine check --helpalso shows the complete description.check.