Skip to content

Commit

Permalink
Auto merge of rust-lang#11726 - Wilfred:todo_docs, r=dswij
Browse files Browse the repository at this point in the history
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.

changelog: [`todo`]: expand docs
  • Loading branch information
bors committed Oct 29, 2023
2 parents a40958a + 58fe451 commit fa6fd8c
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions clippy_lints/src/panic_unimplemented.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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,
Expand All @@ -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
Expand Down

0 comments on commit fa6fd8c

Please sign in to comment.