astral-sh / astral-sh/ruff

`D417` only triggering when I have no `convention`

Open
#16,628 3 comments 0 reactions 0 assignees View on GitHub
docstring documentation question
Dominant language
Rust
Stars
49.6k
Forks
2.4k
Avg merge
2d 1h
Merged PRs (30d)
458

Description

### Summary

[`D417`](https://docs.astral.sh/ruff/rules/undocumented-param/) is supposed to be enabled when `convention = google`, but I can only get it to trigger when I remove my `convention` entirely.

https://play.ruff.rs/6daf08f0-a7fc-4e69-81c8-fb82235e5f87

### Version

`ruff 0.9.10 (0dfa810e9 2025-03-07)`

Contributor guide

Open the contributing guide

Research direction

Reproduce the behavior using the linked Ruff Playground example and Ruff 0.9.10, comparing D417 with and without `convention = google`. Trace the D417 implementation and its convention handling, then verify that the Google convention produces the expected diagnostic and add or update regression coverage if the repository identifies a relevant test location.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.