FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

GH-108202: Combine documentation of ``calendar`` constants by AA-Turner · Pull Request #108492 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

GH-108202: Combine documentation of calendar constants #108492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugovk merged 4 commits into from
Aug 28, 2023
Conversation 7 Commits 4 Checks 0 Files changed
Merged

GH-108202: Combine documentation of calendar constants #108492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eafaeb4
Merge documentation of month and day constants
AA-Turner Aug 25, 2023
ce92dc6
Use preferred short forms
AA-Turner Aug 25, 2023
05b59ad
Define the enum classes
AA-Turner Aug 25, 2023
d249b85
Group day and month data together
AA-Turner Aug 26, 2023
File filter

Filter by extension

Filter by extension .rst  (3) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
109 changes: 49 additions & 60 deletions Doc/library/calendar.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
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
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1013,7 +1013,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
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.13.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -435,8 +435,8 @@ although there is currently no date scheduled for their removal.
* Delegation of ``int()`` to ``__trunc__()`` method.

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

* :mod:`datetime`:
Expand Down
Back | FazBrowse Home | New Git URL