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/08/28 02:55:39 UTC
[PR] docs: fix docstring parameter names that do not match signatures [superset]
LALITH0110 opened a new pull request, #43630:
URL: https://github.com/apache/superset/pull/43630
### SUMMARY
Five docstring entries name parameters that their functions do not accept, so
Sphinx documents arguments a caller cannot pass. Each was checked against the
function signature before changing.
**`superset/migrations/shared/constraints.py`** — `redefine()`:
- The `foreign_key` entry uses the `:params` directive instead of `:param`, so it
is not rendered as a parameter at all. This is the **only** `:params` in
`superset/`, against 1389 correct `:param` uses, so it is a typo rather than a
local convention.
- The same docstring documents `ondelete` and `onupdate`, but the parameters are
`on_delete` and `on_update`.
**`superset/cli/viz_migrations.py`** — `migrate_by_id()` documents `id`; the
parameter is `ids`. The entry's own text ("Tuple of chart IDs to migrate") already
describes the plural.
**`superset/utils/screenshots.py`** — `compute_and_cache()` documents `cache`,
which is not a parameter; the cache itself is `self.cache`. The real parameter is
`cache_key`, used for the cache lookup and as the `DistributedLock` key, and it was
undocumented. The entry is relabelled to `cache_key` and its description corrected
to describe the key rather than the cache — keeping the old wording under the new
name would have read as accurate while being wrong.
Scope is deliberately narrow: parameters that were never documented are left
undocumented rather than newly described, and no wording changes beyond what the
incorrect names require. Docstring-only; no behaviour change.
This is the same class of defect as #42646, found the same way.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Not applicable — no UI or rendered-output change.
### TESTING INSTRUCTIONS
Docstring-only, so there is no behaviour to exercise. Correctness is verifiable by
reading each signature against its docstring:
```
superset/migrations/shared/constraints.py:39 redefine(foreign_key, on_delete, on_update)
superset/cli/viz_migrations.py:159 migrate_by_id(ids, is_downgrade)
superset/utils/screenshots.py:324 compute_and_cache(force, user, window_size, thumb_size, cache_key)
```
Per `AGENTS.md`, `pre-commit` was run on the changed files before pushing, using the
pinned `ruff==0.9.7` from `requirements/development.txt`. All applicable hooks pass:
`mypy`, `ruff`, `ruff-format`, `pylint` (with the custom Superset plugins),
`auto-walrus`, `check-docstring-first`, `Blacklist`, and the whitespace/EOF hooks.
### 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
Note on the migrations file: `constraints.py` is a shared helper used *by*
migrations, not a migration script itself, and only its docstring is touched — no
DB migration is introduced.
--
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 docstring parameter names that do not match signatures [superset]
Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on PR #43630:
URL: https://github.com/apache/superset/pull/43630#issuecomment-5447820299
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 docstring parameter names that do not match signatures [superset]
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #43630:
URL: https://github.com/apache/superset/pull/43630#issuecomment-5447844425
## [Codecov](https://app.codecov.io/gh/apache/superset/pull/43630?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 57.42%. Comparing base ([`13e97ba`](https://app.codecov.io/gh/apache/superset/commit/13e97ba9139d15340e5e44621d54075a0b76adec?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`6ee2e86`](https://app.codecov.io/gh/apache/superset/commit/6ee2e8694ce5138aa6435825d8d271edbc2c1e69?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 3 commits behind head on master.
> :exclamation: There is a different number of reports uploaded between BASE (13e97ba) and HEAD (6ee2e86). Click for more details.
>
> <details><summary>HEAD has 47 uploads less than BASE</summary>
>
>| Flag | BASE (13e97ba) | HEAD (6ee2e86) |
>|------|------|------|
>|python|42|1|
>|presto|7|1|
></details>
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## master #43630 +/- ##
===========================================
- Coverage 79.17% 57.42% -21.75%
===========================================
Files 2879 2879
Lines 165819 165819
Branches 38330 38330
===========================================
- Hits 131290 95229 -36061
- Misses 32056 69695 +37639
+ Partials 2473 895 -1578
```
| [Flag](https://app.codecov.io/gh/apache/superset/pull/43630/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/43630/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [mysql](https://app.codecov.io/gh/apache/superset/pull/43630/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/43630/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/43630/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `39.86% <ø> (ø)` | |
| [python](https://app.codecov.io/gh/apache/superset/pull/43630/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `39.86% <ø> (-43.89%)` | :arrow_down: |
| [sqlite](https://app.codecov.io/gh/apache/superset/pull/43630/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/43630/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/43630?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
Re: [PR] docs: fix docstring parameter names that do not match signatures [superset]
Posted by "netlify[bot] (via GitHub)" <gi...@apache.org>.
netlify[bot] commented on PR #43630:
URL: https://github.com/apache/superset/pull/43630#issuecomment-5447830734
### <span aria-hidden="true">✅</span> Deploy Preview for *superset-docs-preview* ready!
| Name | Link |
|:-:|------------------------|
|<span aria-hidden="true">🔨</span> Latest commit | 6ee2e8694ce5138aa6435825d8d271edbc2c1e69 |
|<span aria-hidden="true">🔍</span> Latest deploy log | https://app.netlify.com/projects/superset-docs-preview/deploys/6a90f8ab80c2850008a4b7de |
|<span aria-hidden="true">😎</span> Deploy Preview | [https://deploy-preview-43630--superset-docs-preview.netlify.app](https://deploy-preview-43630--superset-docs-preview.netlify.app) |
|<span aria-hidden="true">📱</span> Preview on mobile | <details><summary> Toggle QR Code... </summary><br /><br /><br /><br />_Use your smartphone camera to open QR code link._</details> |
|<span aria-hidden="true">🤖</span> Make changes | [Run an agent on this branch](https://app.netlify.com/projects/superset-docs-preview/agent-runs#FcrJDYAgEADAXvYtcUM80A4sY7mURI4AD42xd_E3j3kg5ehThRWgA5kpqKNZR1V66y72o2YXdpYok2eBvCmMt6tNOuO96bYnWtAKkgIVFyMiChrkrA28Hw) |
---
<!-- [superset-docs-preview Preview](https://deploy-preview-43630--superset-docs-preview.netlify.app) -->
_To edit notification comments on pull requests, go to your [Netlify project configuration](https://app.netlify.com/projects/superset-docs-preview/configuration/notifications#deploy-notifications)._
--
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 docstring parameter names that do not match signatures [superset]
Posted by "hainenber (via GitHub)" <gi...@apache.org>.
hainenber merged PR #43630:
URL: https://github.com/apache/superset/pull/43630
--
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