docs: fix parameter name in Explorable.get_query_result docstring - #42646
docs: fix parameter name in Explorable.get_query_result docstring#42646LALITH0110 wants to merge 1 commit into
Conversation
The docstring documented `:param query_obj:`, but the parameter is named `query_object`, so the documented name did not exist on the method and the real one was undocumented.
Code Review Agent Run #e0704bActionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #42646 +/- ##
=======================================
Coverage 65.44% 65.44%
=======================================
Files 2810 2810
Lines 159362 159362
Branches 36372 36372
=======================================
Hits 104301 104301
Misses 53019 53019
Partials 2042 2042
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
SUMMARY
Explorable.get_query_resultdocumented:param query_obj:, but the parameter is namedquery_object:So the docstring described a parameter that does not exist on the method, and the real one was left undocumented. Since this is the primary data-retrieval method on the
Explorableprotocol, the reference is worth having right.One line. Documentation only — no behaviour change.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Not applicable — docstring change, no UI.
TESTING INSTRUCTIONS
No behaviour to exercise; the change is a single word in a docstring. Verified mechanically that the documented parameter now matches the signature:
pre-commit run --files superset/explorables/base.pypasses in full, includingmypy,ruff,ruff-formatandpylint.ADDITIONAL INFORMATION
Found by comparing documented
:paramentries against actual function signatures.