Skip to content

Commit 124f1b0

Browse files
committed
Auto merge of #11574 - unexge:missing-assert-message-docs, r=Alexendoo
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
2 parents 4494b69 + 62b8ef3 commit 124f1b0

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

clippy_lints/src/missing_assert_message.rs

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ 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+
/// Although the same reasoning applies to testing functions, this lint ignores them as they would be too noisy.
19+
/// Also, in most cases understanding the test failure would be easier
20+
/// compared to understanding a complex invariant distributed around the codebase.
21+
///
1822
/// ### Known problems
1923
/// This lint cannot check the quality of the custom panic messages.
2024
/// Hence, you can suppress this lint simply by adding placeholder messages

0 commit comments

Comments
 (0)