[Docs] Add `pydocstyle` to the `ruff` rules by hmellor · Pull Request #52136 · vllm-project/vllm

hmellor · 2026-08-13T09:16:21Z

Enables the D ruleset in ruff and fixes the resulting violations across the codebase.

Config

D100–D107 are ignored, so this does not require a docstring on anything that lacks one today. Six more rules are ignored because their remaining violations were either impossible to autofix or actively wrong to autofix:

Rule	Why skipped
`D205`, `D400`, `D415`	All treat a summary sentence that merely wraps as summary-plus-body. The autofix appends periods to list items.
`D401`, `D404`	Flag idiomatic noun-phrase docstrings on properties and attributes.
`D301`	Churn-only (`r"""` prefixes).

Plus ignore-var-parameters = true (no *args/**kwargs descriptions required) and a tests/** ignore for D417, since test params are mostly pytest fixtures.

Changes

The bulk is autofix output for the mechanical rules (D209, D212, D200, D202, D413, and friends). On top of that, by hand:

~290 Args: entries written across 88 files for D417, mostly in fused_moe, attention backends, and multimodal models. Several were format bugs rather than missing docs: numpy-style Parameters/---------- blocks that ruff's Google parser can't read at all.
807 trailing periods for D400/D415, applied only where D205 doesn't co-fire, so no list items were punctuated.
37 E501 regressions fixed. These were introduced by the D212 autofix collapsing wrapped summaries onto line 1 and pushing them past 88 chars.
A handful of one-offs: D210, D402, D418, D419.

Incidental fixes picked up along the way: typos (videoand, output_dytpe, the m odel) and stale docs naming parameters that no longer exist.

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

mergify · 2026-08-13T09:17:08Z

Documentation preview: https://vllm--52136.org.readthedocs.build/en/52136/

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

hmellor · 2026-08-17T11:15:04Z

/ci run

github-actions · 2026-08-17T11:16:01Z

✅ Triggered Buildkite CI #84198 for commit 5272327b8a93.

Conflicts were resolved by taking main's content for every conflicted file, then re-running `ruff check --fix` and `ruff format` under the pydocstyle config so the docstring changes are regenerated from main's text. The remaining non-autofixable violations (D417/D402/E501) were fixed by hand, reusing the wording this branch had already written where it applied. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

hmellor · 2026-09-16T09:42:08Z

/ci run

github-actions · 2026-09-16T09:42:28Z

✅ Triggered Buildkite CI #89319 for commit 64019d2de29f.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

hmellor · 2026-09-16T10:32:11Z

/ci run

github-actions · 2026-09-16T10:32:29Z

❌ This PR is 2 commits behind upstream main. Your branch must contain every commit currently on upstream main. No new CI build was started. Merge or rebase onto the latest main, then rerun /ci run. To test this branch at your own risk, use /ci run --allow-stale.

hmellor · 2026-09-16T10:36:49Z

/ci run

github-actions · 2026-09-16T10:37:09Z

✅ Triggered Buildkite CI #89328 for commit eda0f3d077f4.

mergify · 2026-09-16T10:46:02Z

Hi @hmellor, the pre-commit checks have failed. Please run:

uv pip install pre-commit>=4.5.1
pre-commit install
pre-commit run --all-files

Then, commit the changes and push to your branch.

For future commits, pre-commit will run automatically on changed files before each commit.

Resolve conflict in tests/v1/kv_connector/unit/test_kv_load_failure_recovery.py by taking main's rewrite (the docstring this branch reformatted was removed upstream), and fix new D200/D212 violations in code merged from main. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

hmellor · 2026-09-16T14:09:30Z

/ci run

github-actions · 2026-09-16T14:09:51Z

✅ Triggered Buildkite CI #89346 for commit 3a73e1d052d3.

hmellor added 6 commits August 13, 2026 09:45

Add pydocstyle to the ruff rules

b7eb903

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

pre-commit run -a ruff-check

7be59d7

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

pre-commit run -a ruff-format

7f036ea

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

pre-commit run -a

4414a10

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

skip some more rules

608641f

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

Fix D400/D415

d0ef835

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

github-project-automation Bot added this to gpt-oss Issues & Enhancements Aug 13, 2026

mergify Bot added the k3 label Aug 13, 2026

github-project-automation Bot moved this to To Triage in gpt-oss Issues & Enhancements Aug 13, 2026

mergify Bot added the nvidia label Aug 13, 2026

github-project-automation Bot added this to NVIDIA Aug 13, 2026

mergify Bot added rocm Related to AMD ROCm intel-gpu Related to Intel GPU labels Aug 13, 2026

github-project-automation Bot added this to AMD Aug 13, 2026

github-project-automation Bot moved this to Todo in AMD Aug 13, 2026

mergify Bot added the cpu Related to CPU backends label Aug 13, 2026

fix docs warnings

5272327

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

hmellor and others added 2 commits September 16, 2026 10:39

Merge branch 'main' into add-pydocstyle

64019d2

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

[Docs] Fix griffe docstring warnings

3696e41

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

Merge branch 'main' into add-pydocstyle

eda0f3d

hmellor mentioned this pull request Sep 16, 2026

[CI] Ignore ruff D209, rejoin the docstrings it split, and silence incompatible-rule warnings #57212

Merged

sfeng33 mentioned this pull request Sep 16, 2026

[CI/Build] Fix D209 docstrings that slipped past the pydocstyle enablement #57213

Closed

khluu mentioned this pull request Sep 17, 2026

[CI] Fix ruff docstring violations in EC connector files #57283

Merged

shen-shanshan mentioned this pull request Sep 17, 2026

[Lint] Fix pre-commit error on main #57293

Closed

3 of 4 tasks

Dreamer-HIT mentioned this pull request Sep 17, 2026

[Bugfix] Honor FP32 precision in batch-invariant matmul #55466

Open

3 tasks done

SuperMarioYL mentioned this pull request Sep 18, 2026

[Perf] Add per-phase cold-start startup span benchmark harness #49037

Open

AshrafAhmed9 mentioned this pull request Sep 18, 2026

[Bugfix] Don't fail the request when a LoRA resolver raises #54428

Open

ybwbqg9379 mentioned this pull request Sep 18, 2026

[Bugfix] Make xgrammar an import-time optional dependency #56565

Closed

macabdul9 mentioned this pull request Sep 18, 2026

[Model] Restore MusicFlamingo for Audio Flamingo Next checkpoints #57622

Open

ZhengGong-amd mentioned this pull request Sep 21, 2026

[Perf][Spec Decode] Filter rejection sampler output rows in Python instead of per-row NumPy #57888

Draft

Kushal9889 mentioned this pull request Sep 24, 2026

[Bugfix][Tool Parser] Make pythonic tool parsers agree across streaming modes #56846

Open

3 of 4 tasks

calvin-fei mentioned this pull request Sep 28, 2026

[Benchmark] Add all-reduce rank-skew calibration #57037

Open

oneKn8 mentioned this pull request Oct 11, 2026

[Bugfix][KVConnector] Key ExampleConnector storage on block hashes #53496

Open

Navigation Menu

Repository navigation

[Docs] Add `pydocstyle` to the `ruff` rules - #52136

[Docs] Add `pydocstyle` to the `ruff` rules#52136
hmellor merged 21 commits into
vllm-project:mainfrom
hmellor:add-pydocstyle

hmellor commented Aug 13, 2026 •

edited

Loading

Uh oh!

mergify Bot commented Aug 13, 2026

Uh oh!

hmellor commented Aug 17, 2026

Uh oh!

github-actions Bot commented Aug 17, 2026

Uh oh!

hmellor commented Sep 16, 2026

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

hmellor commented Sep 16, 2026

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

hmellor commented Sep 16, 2026

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

mergify Bot commented Sep 16, 2026

Uh oh!

hmellor commented Sep 16, 2026

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

hmellor commented Aug 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Config

Changes

Uh oh!

mergify Bot commented Aug 13, 2026

Uh oh!

hmellor commented Aug 17, 2026

Uh oh!

github-actions Bot commented Aug 17, 2026

Uh oh!

hmellor commented Sep 16, 2026

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

hmellor commented Sep 16, 2026

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

hmellor commented Sep 16, 2026

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

mergify Bot commented Sep 16, 2026

Uh oh!

hmellor commented Sep 16, 2026

Uh oh!

github-actions Bot commented Sep 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

hmellor commented Aug 13, 2026 •

edited

Loading