mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-28 21:04:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fix incorrect D413 links in docstrings convention FAQ (#20089)
Some checks are pending
CI / Determine changes (push) Waiting to run
Details
CI / cargo fmt (push) Waiting to run
Details
CI / cargo clippy (push) Blocked by required conditions
Details
CI / cargo test (linux) (push) Blocked by required conditions
Details
CI / cargo test (linux, release) (push) Blocked by required conditions
Details
CI / cargo test (windows) (push) Blocked by required conditions
Details
CI / cargo test (wasm) (push) Blocked by required conditions
Details
CI / cargo build (release) (push) Waiting to run
Details
CI / mkdocs (push) Waiting to run
Details
CI / cargo build (msrv) (push) Blocked by required conditions
Details
CI / cargo fuzz build (push) Blocked by required conditions
Details
CI / fuzz parser (push) Blocked by required conditions
Details
CI / test scripts (push) Blocked by required conditions
Details
CI / ecosystem (push) Blocked by required conditions
Details
CI / Fuzz for new ty panics (push) Blocked by required conditions
Details
CI / cargo shear (push) Blocked by required conditions
Details
CI / python package (push) Waiting to run
Details
CI / pre-commit (push) Waiting to run
Details
CI / formatter instabilities and black similarity (push) Blocked by required conditions
Details
CI / test ruff-lsp (push) Blocked by required conditions
Details
CI / check playground (push) Blocked by required conditions
Details
CI / benchmarks-instrumented (push) Blocked by required conditions
Details
CI / benchmarks-walltime (push) Blocked by required conditions
Details
[ty Playground] Release / publish (push) Waiting to run
Details

Browse source 
## Summary

D413 in this section was incorrectly linking to D410.

I haven't checked if this issue happens anywhere else in the docs.

## Test Plan

Look at docs
This commit is contained in:
Avasam 2025-08-26 00:54:58 -04:00 • committed by GitHub
parent 8d6dc7d3a3
commit 911d5cc973
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/faq.md
View file

@ -560,7 +560,7 @@ The PEP 257 convention includes all `D` errors apart from:
[`D409`](rules/mismatched-section-underline-length.md), [`D409`](rules/mismatched-section-underline-length.md),
[`D410`](rules/no-blank-line-after-section.md), [`D410`](rules/no-blank-line-after-section.md),
[`D411`](rules/no-blank-line-before-section.md), [`D411`](rules/no-blank-line-before-section.md),
[`D413`](rules/no-blank-line-after-section.md), [`D413`](rules/missing-blank-line-after-last-section.md),
[`D415`](rules/missing-terminal-punctuation.md), [`D415`](rules/missing-terminal-punctuation.md),
[`D416`](rules/missing-section-name-colon.md), and [`D416`](rules/missing-section-name-colon.md), and
[`D417`](rules/undocumented-param.md). [`D417`](rules/undocumented-param.md).
@ -571,7 +571,7 @@ The NumPy convention includes all `D` errors apart from:
[`D212`](rules/multi-line-summary-first-line.md), [`D212`](rules/multi-line-summary-first-line.md),
[`D213`](rules/multi-line-summary-second-line.md), [`D213`](rules/multi-line-summary-second-line.md),
[`D402`](rules/signature-in-docstring.md), [`D402`](rules/signature-in-docstring.md),
[`D413`](rules/no-blank-line-after-section.md), [`D413`](rules/missing-blank-line-after-last-section.md),
[`D415`](rules/missing-terminal-punctuation.md), [`D415`](rules/missing-terminal-punctuation.md),
[`D416`](rules/missing-section-name-colon.md), and [`D416`](rules/missing-section-name-colon.md), and
[`D417`](rules/undocumented-param.md). [`D417`](rules/undocumented-param.md).
@ -588,7 +588,7 @@ The Google convention includes all `D` errors apart from:
[`D407`](rules/missing-dashed-underline-after-section.md), [`D407`](rules/missing-dashed-underline-after-section.md),
[`D408`](rules/missing-section-underline-after-name.md), [`D408`](rules/missing-section-underline-after-name.md),
[`D409`](rules/mismatched-section-underline-length.md), and [`D409`](rules/mismatched-section-underline-length.md), and
[`D413`](rules/no-blank-line-after-section.md). [`D413`](rules/missing-blank-line-after-last-section.md).
By default, no [`convention`](settings.md#lint_pydocstyle_convention) is set, and so the enabled rules By default, no [`convention`](settings.md#lint_pydocstyle_convention) is set, and so the enabled rules
are determined by the [`select`](settings.md#lint_select) setting alone. are determined by the [`select`](settings.md#lint_select) setting alone.