-
Notifications
You must be signed in to change notification settings - Fork 311
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 description of check command. #1227
base: main
Are you sure you want to change the base?
Conversation
added. | ||
|
||
Note: check is not intended to catch all reasons why an upload to PyPI might fail. |
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.
The docstring doesn't need updating unless I'm mistaken
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.
Some people might look at twine check --help
, but others might look at the docs, i.e. twine.commands.check.check. From what I understand only the docstrings are shown there and not the new description
, so it does make sense to also change it.
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.
That is specifically listed internally as part of contributor guidelines. No end user should be relying on the docstring for understanding how this command works.
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.
I looked at the contributor guidelines and didn't see anything about docstrings, so not really sure what you mean. I have no problem in removing that change. But note, not all end users are familiar with CLIs or them normally having a --help
option. Just because somewhere it says that end users should not rely on what is in the official docs https://twine.readthedocs.io/, doesn't mean they won't. On the other hand, the comment about the long_description
was already in the docstring. Do you mean to say that it shouldn't be there?
Co-authored-by: Ian Stapleton Cordasco <graffatcolmingov@gmail.com>
Creating this pull request as proposed in #1152 (comment) by @woodruffw. It modifies the description of the check command such that:
twine check --help
also shows the complete description.check
.