Fix docstring Args entries that name a parameter the function does not take - #8995
Merged
Merged
Conversation
Author
|
Sorry — the flake8 failure was mine. Removing all three entries from |
Member
|
Thanks! CI issues are unrelated. |
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.
Fourteen
Args:entries name a parameter the function does not take. Docstrings only.Seven renames:
EventFilter._handle_mouse_releasee_eCompleter._change_completed_parttextnewtextCompletionModel._cat_from_idxidxindexHostBlocker._read_hosts_linelineraw_lineBaseKeyParser._debug_logmessagemsg_is_url_dnsurlurlstrDownloadModel._on_data_changedstart+endidxThe last one had two entries where the signature has one:
start/endare from a version that took a range.The rest document an argument that is gone:
countin_tab_close(the helper does not take it — thetab-closecommand does),aliasesin_get_alias,idxin_update_window_title, andpages,cmdhistandexcin_gather_crash_info, which takes onlyself.I left two groups alone, since both look like house convention rather than mistakes:
Args:—GUIProcess,SocketError,ListenError,LineParser,NeighborList. Their__init__arguments are documented separately in the constructor.countentries on the@cmdutils.registercommands inmisccommands.py.countis the argument the command takes;cmdutils.Value.count_tabturns it intotabbefore the Python function sees it, and the command help is built from that docstring.Everything here was opened and read against the code first.