Skip to content

Improve description of check command. #1227

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

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

Improve description of check command. #1227

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4aa4e69
Improve description of check command.
mauvilsa Jan 30, 2025
0b69c0b
Fix ArgumentParser description
mauvilsa Jan 30, 2025
470a0de
Update twine/commands/check.py
mauvilsa Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions twine/commands/check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,11 @@ def check(
) -> bool:
"""Check that a distribution will render correctly on PyPI and display the results.

This is currently only validates ``long_description``, but more checks could be
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.
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?


:param dists:
The distribution files to check.
:param output_stream:
Expand Down Expand Up @@ -174,7 +176,13 @@ def main(args: List[str]) -> bool:
:return:
The exit status of the ``check`` command.
"""
parser = argparse.ArgumentParser(prog="twine check")
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.
"""
parser = argparse.ArgumentParser(prog="twine check", description=description)
parser.add_argument(
"dists",
nargs="+",
Expand Down