GH-108202: Combine documentation of ``calendar`` constants (#108492)

This commit is contained in:
Adam Turner 2023-08-28 06:19:31 +01:00 committed by GitHub
parent d0160c7c22
commit 5d936b6479
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 52 additions and 63 deletions

View File

@ -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. 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) .. class:: Calendar(firstweekday=0)
Creates a :class:`Calendar` object. *firstweekday* is an integer specifying the Creates a :class:`Calendar` object. *firstweekday* is an integer specifying the
@ -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. 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 .. data:: month_name
An array that represents the months of the year in the current locale. This An array that represents the months of the year in the current locale. This
@ -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 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. 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: The :mod:`calendar` module defines the following exceptions:

View File

@ -1013,7 +1013,7 @@ Deprecated
(Contributed by Serhiy Storchaka and Guido van Rossum in :gh:`100160`.) (Contributed by Serhiy Storchaka and Guido van Rossum in :gh:`100160`.)
* :mod:`calendar`: ``calendar.January`` and ``calendar.February`` constants are deprecated and * :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`.) (Contributed by Prince Roshan in :gh:`103636`.)
* :mod:`datetime`: :class:`datetime.datetime`'s :meth:`~datetime.datetime.utcnow` and * :mod:`datetime`: :class:`datetime.datetime`'s :meth:`~datetime.datetime.utcnow` and

View File

@ -438,8 +438,8 @@ although there is currently no date scheduled for their removal.
* Delegation of ``int()`` to ``__trunc__()`` method. * Delegation of ``int()`` to ``__trunc__()`` method.
* :mod:`calendar`: ``calendar.January`` and ``calendar.February`` constants are * :mod:`calendar`: ``calendar.January`` and ``calendar.February`` constants are
deprecated and replaced by :data:`calendar.Month.JANUARY` and deprecated and replaced by :data:`calendar.JANUARY` and
:data:`calendar.Month.FEBRUARY`. :data:`calendar.FEBRUARY`.
(Contributed by Prince Roshan in :gh:`103636`.) (Contributed by Prince Roshan in :gh:`103636`.)
* :mod:`datetime`: * :mod:`datetime`: