Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that D417 only checks docstrings with an arguments section #16494

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −2
Open

Clarify that D417 only checks docstrings with an arguments section #16494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions crates/ruff_linter/src/rules/pydocstyle/rules/sections.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1167,9 +1167,10 @@ impl AlwaysFixableViolation for MissingSectionNameColon {
/// a blank line, followed by a series of sections, each with a section header
/// and a section body. Function docstrings often include a section for
/// function arguments; this rule is concerned with that section only.
/// This rule does not check functions without any arguments sections (e.g. `Args`).
///
/// This rule is enabled when using the `google` convention, and disabled when
/// using the `pep257` and `numpy` conventions.
/// Note that this rule only checks docstrings with an arguments (e.g. `Args`) section.
/// Docstrings without any arguments sections
///
/// ## Example
/// ```python
Expand Down
Loading