https://github.com/python/cpython/commit/d12434b4661c6be7430002e66a54d920f7d4ca7f
commit: d12434b4661c6be7430002e66a54d920f7d4ca7f
branch: main
author: Vyron Vasileiadis <[email protected]>
committer: tomasr8 <[email protected]>
date: 2026-07-18T14:29:23+02:00
summary:
gh-153926: Fix documented parameter name for `calendar.calendar` and
`calendar.prcal` (#153927)
gh-153926: Fix documented parameter name for calendar.calendar and
calendar.prcal
calendar.calendar() and calendar.prcal() are bound methods of the
module's TextCalendar instance, whose first parameter is named theyear,
but the documentation named it year, so the documented keyword raised
TypeError. Update the documentation to match the real signature, which
also matches the sibling month() and prmonth() functions.
files:
M Doc/library/calendar.rst
diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst
index 60cd214b450101..b486425204946d 100644
--- a/Doc/library/calendar.rst
+++ b/Doc/library/calendar.rst
@@ -430,12 +430,12 @@ For simple text calendars this module provides the
following functions.
of the :class:`TextCalendar` class.
-.. function:: prcal(year, w=0, l=0, c=6, m=3)
+.. function:: prcal(theyear, w=0, l=0, c=6, m=3)
Prints the calendar for an entire year as returned by :func:`calendar`.
-.. function:: calendar(year, w=2, l=1, c=6, m=3)
+.. function:: calendar(theyear, w=2, l=1, c=6, m=3)
Returns a 3-column calendar for an entire year as a multi-line string using
the :meth:`~TextCalendar.formatyear` of the :class:`TextCalendar` class.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
