]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-108202: Document calendar.Calendar.firstweekday (#128566)
authorErlend E. Aasland <erlend@python.org>
Tue, 7 Jan 2025 07:59:24 +0000 (08:59 +0100)
committerGitHub <noreply@github.com>
Tue, 7 Jan 2025 07:59:24 +0000 (08:59 +0100)
Doc/library/calendar.rst

index dadd301ebc795bf6a0f6939835e38ac742a428be..f25930eb0d873eb346b6dafb1022dc4e4005e15d 100644 (file)
@@ -38,21 +38,33 @@ interpreted as prescribed by the ISO 8601 standard.  Year 0 is 1 BC, year -1 is
    itself. This is the job of subclasses.
 
 
-   :class:`Calendar` instances have the following methods:
+   :class:`Calendar` instances have the following methods and attributes:
+
+   .. attribute:: firstweekday
+
+      The first weekday as an integer (0--6).
+
+      This property can also be set and read using
+      :meth:`~Calendar.setfirstweekday` and
+      :meth:`~Calendar.getfirstweekday` respectively.
 
    .. method:: getfirstweekday()
 
-      Return an :class:`int` for the current first weekday (0-6).
+      Return an :class:`int` for the current first weekday (0--6).
+
+      Identical to reading the :attr:`~Calendar.firstweekday` property.
 
    .. method:: setfirstweekday(firstweekday)
 
-      Set the first weekday to *firstweekday*, passed as an :class:`int` where Monday is 0 and Sunday is 6.
+      Set the first weekday to *firstweekday*, passed as an :class:`int` (0--6)
+
+      Identical to setting the :attr:`~Calendar.firstweekday` property.
 
    .. method:: iterweekdays()
 
       Return an iterator for the week day numbers that will be used for one
       week.  The first value from the iterator will be the same as the value of
-      the :attr:`firstweekday` property.
+      the :attr:`~Calendar.firstweekday` property.
 
 
    .. method:: itermonthdates(year, month)