Skip to content

Commit

Permalink
Document InvalidWheelFilename and InvalidSdistFilename
Browse files Browse the repository at this point in the history
Also applied suggestions from code review

Co-authored-by: Brett Cannon <brett@python.org>
  • Loading branch information
MrMino and brettcannon committed Aug 16, 2022
1 parent b0515ff commit 5839a3f
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/utils.rst
Expand Up @@ -63,7 +63,7 @@ Reference
instance of :class:`~packaging.tags.Tag`.

:param str filename: The name of the wheel file.
:raises packaging.utils.InvalidWheelFilename: If the filename in question
:raises InvalidWheelFilename: If the filename in question
does not follow conventions outlined in `PEP 427`_.

.. doctest::
Expand All @@ -89,7 +89,7 @@ Reference
represented by an instance of :class:`~packaging.version.Version`.

:param str filename: The name of the sdist file.
:raises packaging.utils.InvalidSdistFilename: If the filename does not end
:raises InvalidSdistFilename: If the filename does not end
with an sdist extension (``.zip`` or ``.tar.gz``), or if it does not
contain a dash separating the name and the version of the distribution.

Expand All @@ -103,5 +103,14 @@ Reference
>>> ver == Version('1.0')
True


.. exception:: InvalidWheelFilename

Raised when a file name for a wheel is invalid.

.. exception:: InvalidSdistFilename

Raised when 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 5839a3f

Please sign in to comment.