We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
pydoclint
DOC501
1 parent c1b292a commit 8659f2fCopy full SHA for 8659f2f
crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs
@@ -19,9 +19,9 @@ use crate::rules::pydocstyle::settings::Convention;
19
/// explicitly-raised exceptions.
20
///
21
/// ## 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.
+/// If a function raises an exception without documenting it in its docstring,
+/// it can be misleading to users and/or a sign of incomplete documentation or
+/// refactors.
25
26
/// ## Example
27
/// ```python
0 commit comments