From 51e7f3d51019810e370d669ce89465b859aa60bd Mon Sep 17 00:00:00 2001 From: Kevin Gillette Date: Mon, 1 Nov 2021 10:28:17 -0600 Subject: [PATCH] .golangci.example.yml: clarify nolintlint.allow-unused nolintlint's allow-usued option comment is misleading: use of "enable" suggests that setting the value to true will ensure all directives are used. Further, it's unclear what "used" means in this context (it could be misread that every possible linter must be specified in at least one nolint directive). --- .golangci.example.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.golangci.example.yml b/.golangci.example.yml index c7023375ea0a..a8187e013816 100644 --- a/.golangci.example.yml +++ b/.golangci.example.yml @@ -518,7 +518,7 @@ linters-settings: block-size: 1 nolintlint: - # Enable to ensure that nolint directives are all used. Default is true. + # Disable to ensure that all nolint directives actually have an effect. Default is true. allow-unused: false # Disable to ensure that nolint directives don't have a leading space. Default is true. allow-leading-space: true