Fix docstring Args names that do not match the signatures - #6685
Open
darkdi wants to merge 2 commits into
Open
Conversation
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.
Twenty-six
Args:entries name a parameter the function does not have. Docstring only — no behaviour changes, no signatures touched.Most are plain renames where the docstring kept the old name:
_binary_encode.encode_nonedatum_datum_loop.loop_from_indexboolwrap_styles_cache.render_widgetregioncropcontainers.ScrollableContainercan_maximizedcan_maximizeBoxProperty.__set__valueborderSpacingProperty.__set__stylespacingFractionalProperty.__get__objtypetypeSyntaxAwareDocument.get_lineline_indexindexDriver.process_messageeventmessageLinuxDriver._patch_lflag(and the inline driver)attributesattrsWidgetPlacement.translateoffsettranslate_offsetScreen.arrangeoptimal_optimalPadding.__init__Visualvisualwalk_selectable_widgetsboundedcontainersChopsUpdate.__init__cropspansFuzzySearch.scoresearchcandidate,positionsThe rest document a parameter that is simply gone:
consoleinrender_border_label,StylesCache.renderandrender_line;startinClock.__init__;num_values_suppliedinscalar_help_text;pathinStylesheet.add_source;backgroundinTextOpacity.process_segments;container_widthinVisual.get_minimal_width; andcompose_parentin_initialize_data_bind, which takes no arguments at all.Three needed a description rather than a rename, since the old text described the wrong thing:
ChopsUpdate.__init__—spansis the(y, x1, x2)list iterated in__rich_console__, not a crop region.SpacingProperty.__set__— the old entry described aStyle; the argument isSpacingDimensions.FuzzySearch.score— split into the two arguments it actually takes.Every one was opened and read against its signature.
black --checkpasses on all touched files.