Skip to content

Conversation

@augustelalande
Copy link
Contributor

Summary

This PR refactors D417 to use the parameters detected in the pydoclint scope, the goal is to have a D417 implementation which is equivalent to the previous one, but uses the pydoclint docstring processing. Later on D417 can be renamed to DOC101 and D417 deprecated. This will make deploying DOC101 easier.

The goal of this PR is to not introduce any ecosystem changes.

Test Plan

The refactor is tested on the old fixtures, and the new snap was manually diffed to ensure no changes.

@augustelalande augustelalande marked this pull request as draft October 30, 2025 23:52
@augustelalande augustelalande changed the title [pydocstyle] Refactor D417 to use the pydoclint scope [pydocstyle] Refactor D417 to use the pydoclint docstring processing Oct 30, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

ℹ️ ecosystem check detected linter changes. (+8 -8 violations, +0 -0 fixes in 2 projects; 53 projects unchanged)

apache/superset (+0 -5 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --preview --select ALL

- scripts/erd/erd.py:84:5: D417 Missing argument descriptions in the docstring for `introspect_sqla_model`: `mapper`, `seen`
- superset/migrations/shared/catalogs.py:131:5: D417 Missing argument descriptions in the docstring for `print_processed_batch`: `batch_size`, `model`, `offset`, `start_time`, `total_rows`
- superset/migrations/shared/catalogs.py:166:5: D417 Missing argument descriptions in the docstring for `update_catalog_column`: `catalog`, `database`, `downgrade`, `session`
- superset/migrations/shared/catalogs.py:295:5: D417 Missing argument descriptions in the docstring for `delete_models_non_default_catalog`: `catalog`, `database`, `session`
- superset/utils/pandas_postprocessing/histogram.py:24:5: D417 Missing argument descriptions in the docstring for `histogram`: `bins`, `column`, `cumulative`, `df`, `groupby`, `normalize`

bokeh/bokeh (+8 -3 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --preview --select ALL

- src/bokeh/core/has_props.py:421:9: D417 Missing argument description in the docstring for `set_from_json`: `value`
+ src/bokeh/core/has_props.py:421:9: D417 Missing argument descriptions in the docstring for `set_from_json`: `setter`, `value`
+ src/bokeh/document/models.py:257:9: D417 Missing argument descriptions in the docstring for `update_name`: `new_name`, `old_name`
+ src/bokeh/events.py:253:9: D417 Missing argument description in the docstring for `__init__`: `model`
- src/bokeh/io/notebook.py:258:5: D417 Missing argument description in the docstring for `push_notebook`: `handle`
+ src/bokeh/io/notebook.py:258:5: D417 Missing argument descriptions in the docstring for `push_notebook`: `document`, `handle`, `state`
- src/bokeh/model/model.py:326:9: D417 Missing argument descriptions in the docstring for `js_link`: `attr_selector`, `other`, `other_attr`
+ src/bokeh/model/model.py:326:9: D417 Missing argument descriptions in the docstring for `js_link`: `attr`, `attr_selector`, `other`, `other_attr`
+ src/bokeh/palettes.py:1510:5: D417 Missing argument descriptions in the docstring for `linear_palette`: `n`, `palette`
+ src/bokeh/palettes.py:1532:5: D417 Missing argument descriptions in the docstring for `diverging_palette`: `midpoint`, `n`, `palette1`, `palette2`
+ src/bokeh/resources.py:194:5: DOC501 Raised exception `RuntimeError` missing from docstring

Changes by rule (2 rules affected)

code total + violation - violation + fix - fix
D417 15 7 8 0 0
DOC501 1 1 0 0 0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant