Skip to content

Commit

Permalink
[3.12] GH-108202: Combine documentation of calendar constants (GH…
Browse files Browse the repository at this point in the history
…-108492) (#108579)

[3.12] GH-108202: Combine documentation of ``calendar`` constants (GH-108492).
(cherry picked from commit 5d936b6)
  • Loading branch information
AA-Turner authored Aug 28, 2023
1 parent f5c5f32 commit 7c7b2bf
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 61 deletions.
109 changes: 49 additions & 60 deletions Doc/library/calendar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,58 +28,6 @@ interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is
2 BC, and so on.


.. class:: Day

Enumeration defining the days of the week as integer constants, from 0 to 6.

.. attribute:: MONDAY

.. attribute:: TUESDAY

.. attribute:: WEDNESDAY

.. attribute:: THURSDAY

.. attribute:: FRIDAY

.. attribute:: SATURDAY

.. attribute:: SUNDAY

.. versionadded:: 3.12


.. class:: Month

Enumeration defining months of the year as integer constants, from 1 to 12.

.. attribute:: JANUARY

.. attribute:: FEBRUARY

.. attribute:: MARCH

.. attribute:: APRIL

.. attribute:: MAY

.. attribute:: JUNE

.. attribute:: JULY

.. attribute:: AUGUST

.. attribute:: SEPTEMBER

.. attribute:: OCTOBER

.. attribute:: NOVEMBER

.. attribute:: DECEMBER

.. versionadded:: 3.12


.. class:: Calendar(firstweekday=0)

Creates a :class:`Calendar` object. *firstweekday* is an integer specifying the
Expand Down Expand Up @@ -446,6 +394,29 @@ The :mod:`calendar` module exports the following data attributes:
An array that represents the abbreviated days of the week in the current locale.


.. data:: MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

Aliases for the days of the week,
where ``MONDAY`` is ``0`` and ``SUNDAY`` is ``6``.

.. versionadded:: 3.12


.. class:: Day

Enumeration defining days of the week as integer constants.
The members of this enumeration are exported to the module scope as
:data:`MONDAY` through :data:`SUNDAY`.

.. versionadded:: 3.12


.. data:: month_name

An array that represents the months of the year in the current locale. This
Expand All @@ -459,15 +430,33 @@ The :mod:`calendar` module exports the following data attributes:
locale. This follows normal convention of January being month number 1, so it
has a length of 13 and ``month_abbr[0]`` is the empty string.

.. data:: MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

Aliases for day numbers, where ``MONDAY`` is ``0`` and ``SUNDAY`` is ``6``.
.. data:: JANUARY
FEBRUARY
MARCH
APRIL
MAY
JUNE
JULY
AUGUST
SEPTEMBER
OCTOBER
NOVEMBER
DECEMBER

Aliases for the months of the year,
where ``JANUARY`` is ``1`` and ``DECEMBER`` is ``12``.

.. versionadded:: 3.12


.. class:: Month

Enumeration defining months of the year as integer constants.
The members of this enumeration are exported to the module scope as
:data:`JANUARY` through :data:`DECEMBER`.

.. versionadded:: 3.12


The :mod:`calendar` module defines the following exceptions:
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1014,7 +1014,7 @@ Deprecated
(Contributed by Serhiy Storchaka and Guido van Rossum in :gh:`100160`.)

* :mod:`calendar`: ``calendar.January`` and ``calendar.February`` constants are deprecated and
replaced by :data:`calendar.Month.JANUARY` and :data:`calendar.Month.FEBRUARY`.
replaced by :data:`calendar.JANUARY` and :data:`calendar.FEBRUARY`.
(Contributed by Prince Roshan in :gh:`103636`.)

* :mod:`datetime`: :class:`datetime.datetime`'s :meth:`~datetime.datetime.utcnow` and
Expand Down

0 comments on commit 7c7b2bf

Please sign in to comment.