]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] GH-108202: Document ``calendar`` exceptions (GH-108398) (#108467)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 25 Aug 2023 16:20:38 +0000 (09:20 -0700)
committerGitHub <noreply@github.com>
Fri, 25 Aug 2023 16:20:38 +0000 (18:20 +0200)
GH-108202: Document ``calendar`` exceptions (GH-108398)
(cherry picked from commit 135098743a0fae0efbcd98e35458e5bc721702e9)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Doc/library/calendar.rst

index 07d04a1c7b582af34e071c2eead089bb835279e3..3c097f4cf7abd9608ce4f4f88cfdd0a42433e7fe 100644 (file)
@@ -469,6 +469,29 @@ The :mod:`calendar` module exports the following data attributes:
 
    Aliases for day numbers, where ``MONDAY`` is ``0`` and ``SUNDAY`` is ``6``.
 
+
+The :mod:`calendar` module defines the following exceptions:
+
+.. exception:: IllegalMonthError(month)
+
+   A subclass of :exc:`ValueError`,
+   raised when the given month number is outside of the range 1-12 (inclusive).
+
+   .. attribute:: month
+
+      The invalid month number.
+
+
+.. exception:: IllegalWeekdayError(weekday)
+
+   A subclass of :exc:`ValueError`,
+   raised when the given weekday number is outside of the range 0-6 (inclusive).
+
+   .. attribute:: weekday
+
+      The invalid weekday number.
+
+
 .. seealso::
 
    Module :mod:`datetime`