[3.15] gh-153926: Fix documented parameter name for `calendar.calendar` and `calendar...

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 d12434b4661c6be7430002e66a54d920f7d4ca7f)

Co-authored-by: Vyron Vasileiadis <hi@fedonman.com>

diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst
index 60cd214b4501010a575db1183d8a8bb873da9202..b486425204946dd9a5f2756bffb325bd54d31e4f 100644 (file)
--- 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.