Skip to content

Commit

Permalink
Auto merge of #11574 - unexge:missing-assert-message-docs, r=Alexendoo
Browse files Browse the repository at this point in the history
Mention that `missing_assert_message` lint ignores test functions

Updates `missing_assert_message`'s docs to reflect that it ignores test functions as pointed out by `@mickvangelderen` in #10362 (comment)

---

changelog: [`missing_assert_message`]: Update docs to reflect this lint ignores test functions
  • Loading branch information
bors committed Sep 28, 2023
2 parents 4494b69 + 62b8ef3 commit 124f1b0
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 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,10 @@ 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.
///
/// Although the same reasoning applies to testing functions, this lint ignores them as they would be too noisy.
/// Also, in most cases understanding the test failure would be easier
/// compared to understanding a complex invariant distributed around the codebase.
///
/// ### Known problems
/// This lint cannot check the quality of the custom panic messages.
/// Hence, you can suppress this lint simply by adding placeholder messages
Expand Down

0 comments on commit 124f1b0

Please sign in to comment.