Skip to content

Commit b009722

Browse files
[3.15] gh-153926: Fix documented parameter name for calendar.calendar and calendar.prcal (GH-153927) (#153937)
gh-153926: Fix documented parameter name for `calendar.calendar` and `calendar.prcal` (GH-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. (cherry picked from commit d12434b) Co-authored-by: Vyron Vasileiadis <hi@fedonman.com>
1 parent 294e563 commit b009722

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

Doc/library/calendar.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -430,12 +430,12 @@ For simple text calendars this module provides the following functions.
430430
of the :class:`TextCalendar` class.
431431

432432

433-
.. function:: prcal(year, w=0, l=0, c=6, m=3)
433+
.. function:: prcal(theyear, w=0, l=0, c=6, m=3)
434434

435435
Prints the calendar for an entire year as returned by :func:`calendar`.
436436

437437

438-
.. function:: calendar(year, w=2, l=1, c=6, m=3)
438+
.. function:: calendar(theyear, w=2, l=1, c=6, m=3)
439439

440440
Returns a 3-column calendar for an entire year as a multi-line string using
441441
the :meth:`~TextCalendar.formatyear` of the :class:`TextCalendar` class.

0 commit comments

Comments
 (0)