Add Known problems section

Co-authored-by: Weihang Lo <me@weihanglo.tw>
This commit is contained in:
unexge 2023-03-05 14:25:22 +00:00
parent 87f58a1a4f
commit b554ff4cd8

View file

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