[3.13] gh-108202: Document calendar.Calendar.firstweekday (GH-128566) (#128579)

(cherry picked from commit b3cbd8f1b5)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
This commit is contained in:
Miss Islington (bot) 2025-01-07 09:05:09 +01:00 committed by GitHub
parent bbe0b33d2a
commit 8f3e5554ba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View 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)