diff options
| author | Wilfred Hughes <wilfred@meta.com> | 2023-10-27 10:22:41 -0700 |
|---|---|---|
| committer | Wilfred Hughes <wilfred@meta.com> | 2023-10-27 10:22:41 -0700 |
| commit | 58fe45102de21fb0806f7f58e85ce1f4ec7e490e (patch) | |
| tree | 53f4518c29d4ee918b674a5e7a36c6509515e237 /clippy_lints/src | |
| parent | 2f0f4ddcf73a82115168d187a5c2121b413e34a2 (diff) | |
Expand docs on clippy::todo
https://doc.rust-lang.org/nightly/core/macro.todo.html describes that `todo!()` is intended for explicitly unfinished code. Explain this, and mention `unimplemented!()` as an alternative. Whilst we're here, improve the punctuation on the other lints.
Diffstat (limited to 'clippy_lints/src')
| -rw-r--r-- | clippy_lints/src/panic_unimplemented.rs | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/clippy_lints/src/panic_unimplemented.rs b/clippy_lints/src/panic_unimplemented.rs index a72aefe91c1..f4f1f6ddb3f 100644 --- a/clippy_lints/src/panic_unimplemented.rs +++ b/clippy_lints/src/panic_unimplemented.rs @@ -9,7 +9,7 @@ declare_clippy_lint! { /// Checks for usage of `panic!`. /// /// ### Why is this bad? - /// `panic!` will stop the execution of the executable + /// `panic!` will stop the execution of the executable. /// /// ### Example /// ```no_run @@ -26,7 +26,7 @@ declare_clippy_lint! { /// Checks for usage of `unimplemented!`. /// /// ### Why is this bad? - /// This macro should not be present in production code + /// This macro should not be present in production code. /// /// ### Example /// ```no_run @@ -43,12 +43,17 @@ declare_clippy_lint! { /// Checks for usage of `todo!`. /// /// ### Why is this bad? - /// This macro should not be present in production code + /// The `todo!` macro is often used for unfinished code, and it causes + /// code to panic. It should not be present in production code. /// /// ### Example /// ```no_run /// todo!(); /// ``` + /// Finish the implementation, or consider marking it as explicitly unimplemented. + /// ```no_run + /// unimplemented!(); + /// ``` #[clippy::version = "1.40.0"] pub TODO, restriction, @@ -60,7 +65,7 @@ declare_clippy_lint! { /// Checks for usage of `unreachable!`. /// /// ### Why is this bad? - /// This macro can cause code to panic + /// This macro can cause code to panic. /// /// ### Example /// ```no_run |