Repository navigation
Docs: Fix TextCalendar.formatweek() and formatmonthname() signatures - #159516
Open
abhishekacharya200 wants to merge 1 commit into
Open
abhishekacharya200 wants to merge 1 commit into
abhishekacharya200 wants to merge 1 commit into
Conversation
Both methods require the width argument; the documented defaults (w=0 and width=0) do not exist, and formatweek() has no 'w' parameter.
Documentation build overview
|
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
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.
The documented signatures of
TextCalendar.formatweek()andTextCalendar.formatmonthname()don't match the code. In both methodswidthis a required argument:The docs show
formatweek(theweek, w=0)andformatmonthname(theyear, themonth, width=0, withyear=True). If you follow them, you get errors:This PR changes the two signatures to match the code and rewords the
formatweek()description to use width. It only touches the docs, so I think it needs the "skip news" label.