You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "LALITH0110 (via GitHub)" <gi...@apache.org> on 2026/07/31 16:10:32 UTC
[PR] docs: fix parameter name in Explorable.get_query_result docstring [superset]
LALITH0110 opened a new pull request, #42646:
URL: https://github.com/apache/superset/pull/42646
### SUMMARY
`Explorable.get_query_result` documented `:param query_obj:`, but the parameter is named `query_object`:
```python
def get_query_result(self, query_object: QueryObject) -> QueryResult:
"""
...
:param query_obj: QueryObject describing the query
```
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 `Explorable` protocol, 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:
```python
import ast, re
src = open("superset/explorables/base.py").read()
fn = next(n for n in ast.walk(ast.parse(src))
if isinstance(n, ast.FunctionDef) and n.name == "get_query_result")
print([a.arg for a in fn.args.args if a.arg != "self"]) # ['query_object']
print(re.findall(r":param (\w+):", ast.get_docstring(fn))) # ['query_object']
```
`pre-commit run --files superset/explorables/base.py` passes in full, including `mypy`, `ruff`, `ruff-format` and `pylint`.
### ADDITIONAL INFORMATION
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
Found by comparing documented `:param` entries against actual function signatures.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: fix parameter name in Explorable.get_query_result docstring [superset]
Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on PR #42646:
URL: https://github.com/apache/superset/pull/42646#issuecomment-5144983241
AI Code Review is in progress (usually takes 3 to 15 minutes unless it's a very large PR).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: fix parameter name in Explorable.get_query_result docstring [superset]
Posted by "sadpandajoe (via GitHub)" <gi...@apache.org>.
sadpandajoe merged PR #42646:
URL: https://github.com/apache/superset/pull/42646
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: fix parameter name in Explorable.get_query_result docstring [superset]
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #42646:
URL: https://github.com/apache/superset/pull/42646#issuecomment-5145138532
## [Codecov](https://app.codecov.io/gh/apache/superset/pull/42646?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 55.88%. Comparing base ([`7d2b184`](https://app.codecov.io/gh/apache/superset/commit/7d2b184079811d07fd3f525f1b3592987095474a?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`abce68c`](https://app.codecov.io/gh/apache/superset/commit/abce68c3815992e8bb37da2c39fab159f649ba92?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 7 commits behind head on master.
> :exclamation: There is a different number of reports uploaded between BASE (7d2b184) and HEAD (abce68c). Click for more details.
>
> <details><summary>HEAD has 4 uploads less than BASE</summary>
>
>| Flag | BASE (7d2b184) | HEAD (abce68c) |
>|------|------|------|
>|python|6|2|
></details>
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## master #42646 +/- ##
==========================================
- Coverage 65.44% 55.88% -9.57%
==========================================
Files 2810 2810
Lines 159362 159362
Branches 36372 36372
==========================================
- Hits 104301 89061 -15240
- Misses 53019 69469 +16450
+ Partials 2042 832 -1210
```
| [Flag](https://app.codecov.io/gh/apache/superset/pull/42646/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
|---|---|---|
| [hive](https://app.codecov.io/gh/apache/superset/pull/42646/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `38.09% <ø> (ø)` | |
| [mysql](https://app.codecov.io/gh/apache/superset/pull/42646/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [postgres](https://app.codecov.io/gh/apache/superset/pull/42646/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [presto](https://app.codecov.io/gh/apache/superset/pull/42646/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `39.98% <ø> (ø)` | |
| [python](https://app.codecov.io/gh/apache/superset/pull/42646/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `40.03% <ø> (-19.22%)` | :arrow_down: |
| [sqlite](https://app.codecov.io/gh/apache/superset/pull/42646/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [unit](https://app.codecov.io/gh/apache/superset/pull/42646/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
</details>
[:umbrella: View full report in Codecov by Harness](https://app.codecov.io/gh/apache/superset/pull/42646?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org