From b554ff4cd833a60e753050703dc5d1384607d1da Mon Sep 17 00:00:00 2001 From: unexge Date: Sun, 5 Mar 2023 14:25:22 +0000 Subject: [PATCH] Add `Known problems` section Co-authored-by: Weihang Lo --- clippy_lints/src/missing_assert_message.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/clippy_lints/src/missing_assert_message.rs b/clippy_lints/src/missing_assert_message.rs index 2ff0cee2925c..2214a568d9c6 100644 --- a/clippy_lints/src/missing_assert_message.rs +++ b/clippy_lints/src/missing_assert_message.rs @@ -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 }