From 236029b3485a8b36792bd2b564b1bc3be04d2bc1 Mon Sep 17 00:00:00 2001 From: Blazej Michalik <6691643+MrMino@users.noreply.github.com> Date: Tue, 16 Aug 2022 05:18:00 +0200 Subject: [PATCH] Document exceptions in a generic form Suggested during code review Co-authored-by: Brett Cannon --- docs/utils.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/utils.rst b/docs/utils.rst index b100b1ff8..1599653d8 100644 --- a/docs/utils.rst +++ b/docs/utils.rst @@ -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