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 1 commit
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
13 changes: 7 additions & 6 deletions twine/commands/check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,18 +170,19 @@ def check(
def main(args: List[str]) -> bool:
"""Execute the ``check`` command.

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.

:param args:
The command-line arguments.

: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