about summary refs log tree commit diff
diff options
context:
space:
mode:
authorunexge <unexge@gmail.com>2023-03-05 14:25:22 +0000
committerunexge <unexge@gmail.com>2023-03-08 08:52:19 +0000
commitb554ff4cd833a60e753050703dc5d1384607d1da (patch)
treed91f13147d8655a3d22c026164a1b978207c1a3b
parent87f58a1a4fb0a95973add9ff8c0c8e3439599e8a (diff)
downloadrust-b554ff4cd833a60e753050703dc5d1384607d1da.tar.gz
rust-b554ff4cd833a60e753050703dc5d1384607d1da.zip
Add `Known problems` section
Co-authored-by: Weihang Lo <me@weihanglo.tw>
-rw-r--r--clippy_lints/src/missing_assert_message.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/clippy_lints/src/missing_assert_message.rs b/clippy_lints/src/missing_assert_message.rs
index 2ff0cee2925..2214a568d9c 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 }