edited documentation

2020-08-27 16:22:37 -07:00 · 2020-08-27 16:22:37 -07:00 · 8462cce960
commit 8462cce960
parent ceab1a9167
1 changed files with 1 additions and 1 deletions
--- a/clippy_lints/src/panic_in_result.rs
+++ b/clippy_lints/src/panic_in_result.rs
@ -9,7 +9,7 @@
 declare_clippy_lint! {
    /// **What it does:** Checks for usage of `panic!`, `unimplemented!` or `unreachable!` in a function of type result/option.
    ///
-    /// **Why is this bad?** For some codebases,
+    /// **Why is this bad?** For some codebases, it is desirable for functions of type option/result to return an error instead of crashing. Hence unimplemented, panic and unreachable should be avoided.
    ///
    /// **Known problems:** None.
    ///