summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMat S <mscull@gmail.com>2024-09-25 09:24:47 (GMT)
committerGitHub <noreply@github.com>2024-09-25 09:24:47 (GMT)
commit8447c933da308939b06e33544ca9abc9fc46aa8b (patch)
treeae8d49403cde5da718949d0baa9171785c5f41e3 /Doc
parent0d38409f422b7be158a45e59766d8f4605dfa5df (diff)
downloadcpython-8447c933da308939b06e33544ca9abc9fc46aa8b.zip
cpython-8447c933da308939b06e33544ca9abc9fc46aa8b.tar.gz
cpython-8447c933da308939b06e33544ca9abc9fc46aa8b.tar.bz2
gh-123445: calendar: Improve descriptions for day and month attributes (#123483)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/calendar.rst24
1 files changed, 20 insertions, 4 deletions
diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst
index d587605..eafc038 100644
--- a/Doc/library/calendar.rst
+++ b/Doc/library/calendar.rst
@@ -393,13 +393,22 @@ The :mod:`calendar` module exports the following data attributes:
.. data:: day_name
- An array that represents the days of the week in the current locale.
+ A sequence that represents the days of the week in the current locale,
+ where Monday is day number 0.
+
+ >>> import calendar
+ >>> list(calendar.day_name)
+ ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
.. data:: day_abbr
- An array that represents the abbreviated days of the week in the current locale.
+ A sequence that represents the abbreviated days of the week in the current locale,
+ where Mon is day number 0.
+ >>> import calendar
+ >>> list(calendar.day_abbr)
+ ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
.. data:: MONDAY
TUESDAY
@@ -426,17 +435,24 @@ The :mod:`calendar` module exports the following data attributes:
.. data:: month_name
- An array that represents the months of the year in the current locale. This
+ A sequence that represents the months of the year in the current locale. This
follows normal convention of January being month number 1, so it has a length of
13 and ``month_name[0]`` is the empty string.
+ >>> import calendar
+ >>> list(calendar.month_name)
+ ['', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
+
.. data:: month_abbr
- An array that represents the abbreviated months of the year in the current
+ A sequence that represents the abbreviated months of the year in the current
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.
+ >>> import calendar
+ >>> list(calendar.month_abbr)
+ ['', 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
.. data:: JANUARY
FEBRUARY