Repository navigation
docs: Match update_cell_value and bind_task_button parameter names - #2585
Merged
Merged
Conversation
The docstrings documented `column` and `id`, but the parameters are `col` (an index or a column name) and `button_id`.
Collaborator
|
Thank you, @mmporong! Other similar doc updates are welcome! |
Collaborator
|
failures unrelated to pr. merging |
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.
Two docstrings document parameters under names the functions do not take:
render.data_frame'supdate_cell_value(value, *, row, col)documentscolumn. It also says "column index", butcolaccepts a column name too (the method converts astrto its index), so the entry now reads "The column index or name of the cell to update."ui.bind_task_button(task=None, *, button_id)documentsid; the keyword-only parameter isbutton_id.Docstring-only change.
I found these by comparing the numpydoc
Parameterssections undershiny/with the function signatures. The other mismatches the scan reported are in private helpers, the Playwright controller, orbookmark.restore_input, whoseidentry also describes the unresolved/resolved ID distinction. I left that one for a maintainer, since renaming it means rewording that explanation.