From eb229c988003d2a97e3e2e842d1a0b6c20058ad3 Mon Sep 17 00:00:00 2001
From: Ludovic Fernandez <ldez@users.noreply.github.com>
Date: Thu, 24 Feb 2022 20:57:28 +0100
Subject: [PATCH] docs: improve linters page (#2617)

---
 .golangci.example.yml           | 25 +++++++++++++++++++------
 docs/src/docs/usage/linters.mdx |  4 ++--
 2 files changed, 21 insertions(+), 8 deletions(-)

diff --git a/.golangci.example.yml b/.golangci.example.yml
index 725055451c3e..84a5b697ae19 100644
--- a/.golangci.example.yml
+++ b/.golangci.example.yml
@@ -1058,16 +1058,29 @@ linters-settings:
 
   revive:
     # Maximum number of open files at the same time.
-    # https://github.com/mgechev/revive#command-line-flags
+    # See https://github.com/mgechev/revive#command-line-flags
     # Defaults to unlimited.
     max-open-files: 2048
+
+    # When set to false, ignores files with "GENERATED" header, similar to golint.
     # See https://github.com/mgechev/revive#available-rules for details.
+    # Default: false
     ignore-generated-header: true
-    severity: warning
-    enable-all-rules: false
-    # confidence: 0.8
-    # error-code: 0
-    # warning-code: 0
+
+    # Sets the default severity.
+    # See https://github.com/mgechev/revive#configuration
+    # Default: warning
+    severity: error
+
+    # Enable all available rules.
+    # Default: false
+    enable-all-rules: true
+
+    # Sets the default failure confidence.
+    # This means that linting errors with less than 0.8 confidence will be ignored.
+    # Default: 0.8
+    confidence: 0.1
+
     rules:
       # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant
       - name: add-constant
diff --git a/docs/src/docs/usage/linters.mdx b/docs/src/docs/usage/linters.mdx
index ff7da95c4db1..9c94625c6b2e 100644
--- a/docs/src/docs/usage/linters.mdx
+++ b/docs/src/docs/usage/linters.mdx
@@ -8,11 +8,11 @@ To see a list of supported linters and which linters are enabled/disabled:
 golangci-lint help linters
 ```
 
-## Enabled By Default Linters
+## Enabled by Default
 
 {.EnabledByDefaultLinters}
 
-## Disabled By Default Linters (`-E/--enable`)
+## Disabled by Default
 
 {.DisabledByDefaultLinters}