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

Improve description of check command. #1227

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mauvilsa
Copy link

@mauvilsa mauvilsa commented Jan 30, 2025

Creating this pull request as proposed in #1152 (comment) by @woodruffw. It modifies the description of the check command such that:

  • From command line twine check --help also shows the complete description.
  • The description is improved so that it is more clear about the current purpose of check.

added.

Note: check is not intended to catch all reasons why an upload to PyPI might fail.
Copy link
Member

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

Copy link
Author

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.

Copy link
Member

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.

Copy link
Author

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?

twine/commands/check.py Outdated Show resolved Hide resolved
Co-authored-by: Ian Stapleton Cordasco <graffatcolmingov@gmail.com>
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.

2 participants