From ee9b3d11adabae4fd4a200ab5e25fb3d1ac8ab45 Mon Sep 17 00:00:00 2001 From: Jeroen Engels Date: Fri, 6 Jan 2023 16:15:55 +0100 Subject: [PATCH] docs: Give advice on when to use warn --- docs/src/user-guide/configuring/rules.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/user-guide/configuring/rules.md b/docs/src/user-guide/configuring/rules.md index 44e9076edf2..4764b0bffe7 100644 --- a/docs/src/user-guide/configuring/rules.md +++ b/docs/src/user-guide/configuring/rules.md @@ -20,6 +20,8 @@ To change a rule's severity, set the rule ID equal to one of these values: * `"warn"` or `1` - turn the rule on as a warning (doesn't affect exit code) * `"error"` or `2` - turn the rule on as an error (exit code is 1 when triggered) +The `"warn"` severity is meant to be used as a temporary measure. It can be used to enable a rule so that new reported issues can be addressed, without breaking the build due to existing ones. It is recommended to keep the number of these issues low so that new issues get more easily noticed and don't get ignored. + ### Using configuration comments To configure rules inside of a file using configuration comments, use a comment in the following format: