Skip to content

Commit

Permalink
Document exceptions in a generic form
Browse files Browse the repository at this point in the history
Suggested during code review

Co-authored-by: Brett Cannon <brett@python.org>
  • Loading branch information
MrMino and brettcannon committed Aug 16, 2022
1 parent c5a482c commit 3f9b5c5
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions docs/utils.rst
Expand Up @@ -106,15 +106,11 @@ Reference

.. exception:: InvalidWheelFilename

Raised by :func:`parse_wheel_filename`, when attempting to parse a wheel
filename that does not conform to `PEP 427`_
Raised when a file name for a wheel is invalid.

.. exception:: InvalidSdistFilename

Raised by :func:`parse_sdist_filename`, when attempting to parse an sdist
filename that does not end with a ``.zip`` or ``.tar.gz`` extension, or
does not contain any dash character separating name and version of the
distribution (e.g. ``"foo1.0.tar.gz"`` instead of ``"foo-1.0.tar.gz"``).
Raised a source distribution file name is considered invalid.

.. _Source distribution format: https://packaging.python.org/specifications/source-distribution-format/#source-distribution-file-name
.. _`PEP 427`: https://peps.python.org/pep-0427/#file-name-convention

0 comments on commit 3f9b5c5

Please sign in to comment.