Skip to content

Commit 7cab740

Browse files
committed
Clarify that D417 only checks docstrings with an arguments section
1 parent d93ed29 commit 7cab740

File tree

1 file changed

+3
-2
lines changed
  • crates/ruff_linter/src/rules/pydocstyle/rules

1 file changed

+3
-2
lines changed

crates/ruff_linter/src/rules/pydocstyle/rules/sections.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1167,9 +1167,10 @@ impl AlwaysFixableViolation for MissingSectionNameColon {
11671167
/// a blank line, followed by a series of sections, each with a section header
11681168
/// and a section body. Function docstrings often include a section for
11691169
/// function arguments; this rule is concerned with that section only.
1170+
/// This rule does not check functions without any arguments sections (e.g. `Args`).
11701171
///
1171-
/// This rule is enabled when using the `google` convention, and disabled when
1172-
/// using the `pep257` and `numpy` conventions.
1172+
/// Note that this rule only checks docstrings with an arguments (e.g. `Args`) section.
1173+
/// Docstrings without any arguments sections
11731174
///
11741175
/// ## Example
11751176
/// ```python

0 commit comments

Comments
 (0)