Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-11-23 13:13:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #11726 - Wilfred:todo_docs, r=dswij

Browse source 
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
This commit is contained in:
bors 2023-10-29 09:07:51 +00:00
commit fa6fd8c346
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
clippy_lints/src/panic_unimplemented.rs
View file

@ -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