Skip to content

Commit 8659f2f

Browse files
[pydoclint] Fix documentation for DOC501 (#12483)
## Summary The doc was written backwards. mb.
1 parent c1b292a commit 8659f2f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ use crate::rules::pydocstyle::settings::Convention;
1919
/// explicitly-raised exceptions.
2020
///
2121
/// ## Why is this bad?
22-
/// If a raise is mentioned in a docstring, but the function itself does not
23-
/// explicitly raise it, it can be misleading to users and/or a sign of
24-
/// incomplete documentation or refactors.
22+
/// If a function raises an exception without documenting it in its docstring,
23+
/// it can be misleading to users and/or a sign of incomplete documentation or
24+
/// refactors.
2525
///
2626
/// ## Example
2727
/// ```python

0 commit comments

Comments
 (0)