gh-153926: Fix documented parameter name for calendar.calendar and calendar.prcal#153927
Merged
tomasr8 merged 3 commits intoJul 18, 2026
Merged
Conversation
…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.
Documentation build overview
|
tomasr8
approved these changes
Jul 18, 2026
tomasr8
added
sprint
needs backport to 3.13
|
GH-153937 is a backport of this pull request to the 3.15 branch. |
bedevere-app
Bot
removed
the
needs backport to 3.15
|
GH-153938 is a backport of this pull request to the 3.14 branch. |
|
GH-153939 is a backport of this pull request to the 3.13 branch. |
tomasr8
pushed a commit
that referenced
this pull request
Jul 18, 2026
…r` 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>
tomasr8
pushed a commit
that referenced
this pull request
Jul 18, 2026
…r` and `calendar.prcal` (GH-153927) (#153939) 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>
tomasr8
pushed a commit
that referenced
this pull request
Jul 18, 2026
…r` and `calendar.prcal` (GH-153927) (#153938) 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>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
calendar.calendar()andcalendar.prcal()document their first parameter asyear, but both are bound methods of the module'sTextCalendarinstance (calendar = c.formatyear,prcal = c.pryear) whose first parameter is namedtheyear. Callingcalendar.calendar(year=2025)therefore raisesTypeError, whiletheyear=2025works.This updates the documentation to use the real parameter name
theyear, which also matches the siblingmonth()andprmonth()functions documented just above.Fixes #153926.
calendar.calendarandcalendar.prcaldocument parameter asyearbut it is namedtheyear#153926