Skip to content

Commit b554ff4

Browse files
unexgeweihanglo
andcommitted
Add Known problems section
Co-authored-by: Weihang Lo <[email protected]>
1 parent 87f58a1 commit b554ff4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

clippy_lints/src/missing_assert_message.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ declare_clippy_lint! {
1515
/// A good custom message should be more about why the failure of the assertion is problematic
1616
/// and not what is failed because the assertion already conveys that.
1717
///
18+
/// ### Known problems
19+
/// This lint cannot check the quality of the custom panic messages.
20+
/// Hence, you can suppress this lint simply by adding placeholder messages
21+
/// like "assertion failed". However, we recommend coming up with good messages
22+
/// that provide useful information instead of placeholder messages that
23+
/// don't provide any extra information.
24+
///
1825
/// ### Example
1926
/// ```rust
2027
/// # struct Service { ready: bool }

0 commit comments

Comments
 (0)