formatter: make description of require-f-funcs flag consistent with g…

…olangci-lint
Antonboom · Nov 13, 2024 · 8ca1d1a · 8ca1d1a
1 parent 8fd3485
commit 8ca1d1a
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -479,7 +479,7 @@ Also, verbs in the format string of f-assertions are highlighted by an IDE, e.g.
 <br>
 
 > [!CAUTION]
-> `--formatter.require-f-funcs` requires f-assertions **even if there are no variable-length variables**, i.e. it 
+> `--formatter.require-f-funcs` requires f-assertions, **even if there are no variable-length variables**, i.e. it 
 > requires `require.NoErrorf` for both these cases:
 > ```
 > require.NoErrorf(t, err, "unexpected error")

diff --git a/analyzer/testdata/src/checkers-default/blank-import/blank_import_test.go b/analyzer/testdata/src/checkers-default/blank-import/blank_import_test.go
diff --git a/analyzer/testdata/src/checkers-default/suite-dont-use-pkg/suite_dont_use_pkg_test.go b/analyzer/testdata/src/checkers-default/suite-dont-use-pkg/suite_dont_use_pkg_test.go
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -133,7 +133,7 @@ func BindToFlags(cfg *Config, fs *flag.FlagSet) {
 		"to enable go vet's printf checks")
 	fs.BoolVar(&cfg.Formatter.RequireFFuncs,
 		"formatter.require-f-funcs", false,
-		"to require f-assertions if format string is used (even if there are no variable-length variables)")
+		"to require f-assertions (e.g. assert.Equalf) if format string is used, even if there are no variable-length variables.")
 
 	fs.BoolVar(&cfg.GoRequire.IgnoreHTTPHandlers,
 		"go-require.ignore-http-handlers", false,