Skip to content

Commit

Permalink
Update twine/commands/check.py
Browse files Browse the repository at this point in the history
Co-authored-by: Ian Stapleton Cordasco <graffatcolmingov@gmail.com>
  • Loading branch information
mauvilsa and sigmavirus24 authored Feb 3, 2025
1 parent 0b69c0b commit 470a0de
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions twine/commands/check.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,14 @@ def main(args: List[str]) -> bool:
:return:
The exit status of the ``check`` command.
"""
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.
"""
parser = argparse.ArgumentParser(prog="twine check", description=description)
parser.add_argument(
Expand Down

0 comments on commit 470a0de

Please sign in to comment.