Skip to content

Commit

Permalink
Add Known problems section
Browse files Browse the repository at this point in the history
Co-authored-by: Weihang Lo <[email protected]>
  • Loading branch information
unexge and weihanglo committed Mar 5, 2023
1 parent 569fa96 commit 9c5ec69
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions clippy_lints/src/missing_assert_message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ declare_clippy_lint! {
/// A good custom message should be more about why the failure of the assertion is problematic
/// and not what is failed because the assertion already conveys that.
///
/// ### Known problems
/// This lint cannot check the quality of the custom panic messages.
/// Hence, you can suppress this lint simply by adding placeholder messages
/// like "assertion failed". However, we recommend coming up with good messages
/// that provide useful information instead of placeholder messages that
/// don't provide any extra information.
///
/// ### Example
/// ```rust
/// # struct Service { ready: bool }
Expand Down

0 comments on commit 9c5ec69

Please sign in to comment.