Skip to content

Commit

Permalink
[pydoclint] Fix documentation for DOC501 (#12483)
Browse files Browse the repository at this point in the history
## Summary

The doc was written backwards. mb.
  • Loading branch information
augustelalande authored Jul 24, 2024
1 parent c1b292a commit 8659f2f
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ use crate::rules::pydocstyle::settings::Convention;
/// explicitly-raised exceptions.
///
/// ## Why is this bad?
/// If a raise is mentioned in a docstring, but the function itself does not
/// explicitly raise it, it can be misleading to users and/or a sign of
/// 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.
///
/// ## Example
/// ```python
Expand Down

0 comments on commit 8659f2f

Please sign in to comment.