[pydocstyle] Improve discoverability of rules enabled for each convention#24973
Merged
ntBre merged 15 commits intoJun 1, 2026
Conversation
Adds per-convention D-rule exclusion lists and clearer examples to the `lint.pydocstyle.convention` option, addressing discoverability.
Removes the duplicated convention rule-exclusion lists and TOML examples from the FAQ, replacing them with a concise pointer to the `lint.pydocstyle.convention` settings documentation. This avoids content duplication after moving the authoritative explanation to the settings reference (per astral-sh#15217), while preserving discoverability for users who start from the FAQ.
Minor formatting cleanup Regenerates ruff.schema.json with no content changes.
MichaReiser
changed the title
|
Contributor
|
Thanks for working on this! Do you plan to address the test failures showing up in CI? I think it could also be helpful to update your test plan with screenshots of the locally-rendered docs. I'll convert this back to a draft for now. |
Author
|
Hey @ntBre , sure, I'll do that 🤝 , |
Signed-off-by: RafaelJohn9 <[email protected]>
ntBre
reviewed
May 20, 2026
…ing issues due to line length)
Author
|
@ntBre , I've completed the requested changes 🤝 |
ntBre
changed the title
pydocstyle] Improve discoverability of rules enabled for each convention
ntBre
approved these changes
Jun 1, 2026
Co-authored-by: Brent Westbrook <[email protected]>
carljm
added a commit
that referenced
this pull request
Jun 1, 2026
* main: [`pydocstyle`] Improve discoverability of rules enabled for each convention (#24973) [ty] Deduplicate retained use-def place states (#25450) [ty] reduce features of low-level crates depended on by `ty_python_semantic` (#25524) [ty] Fix narrowing enum literal unions by member identity (#25520) [ty] Test tagged union narrowing for named tuples (#25519) [ty] Disallow file-system access in `ty_python_core` (#25518) [ty] Nominal Tagged Union Narrowing (#24916) Commit `scripts/uv.lock` (#25517) Fix potential index out of range in `LineIndex` computation (#25492) [ty] Sync vendored typeshed stubs (#25514) [ty] Add disjointness for protocol method members (#25315) [ty] Use compact sets for more immutable fields (#25476) [ty] Derive `Default` for `FunctionDecoratorInference` (#25482) [ty] Ignore rejected assignments for synthesized bindings (#25340) [ty] Handle cycles in function decorator inference (#25475) docs: fix typo `bin/active` → `bin/activate` in tutorial (#25473) [ty] Narrow bound method overloads by receiver (#24707)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves discoverability of
pydocstyleconvention-based rule filtering by moving the authoritative documentation from the FAQ into thelint.pydocstyle.conventionsettings reference, per #15217.Closes #15217.
Test Plan
Documentation-only change no functional code modifications.
Verification steps:
Ran
cargo dev generate-docsto regeneratedocs/settings.mdandruff.schema.jsonfrom updated docstringsRan
cargo fmt --allto ensure Rust formatting complianceRan
cargo clippy --workspace --all-targets --all-features -- -D warnings- no new warningsServed docs locally with
uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.ymland verified:lint.pydocstyle.conventionsection renders with the new contentScreenshots
/ruff/settings/#lint.pydocstyle/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings