doc: improve documentation for goimport local-prefixes (golangci#3349)

SeigeC · Apr 4, 2023 · 0b58eb6 · 0b58eb6
1 parent 121dea7
commit 0b58eb6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/.golangci.reference.yml b/.golangci.reference.yml
@@ -654,8 +654,8 @@ linters-settings:
     template-path: /path/to/my/template.tmpl
 
   goimports:
-    # Put imports beginning with prefix after 3rd-party packages.
-    # It's a comma-separated list of prefixes.
+    # A comma-separated list of prefixes, which, if set, checks import paths
+    # with the given prefixes are grouped after 3rd-party packages.
     # Default: ""
     local-prefixes: github.com/org/project
 

diff --git a/pkg/golinters/goimports.go b/pkg/golinters/goimports.go
@@ -27,7 +27,8 @@ func NewGoimports(settings *config.GoImportsSettings) *goanalysis.Linter {
 
 	return goanalysis.NewLinter(
 		goimportsName,
-		"In addition to fixing imports, goimports also formats your code in the same style as gofmt.",
+		"Check import statements are formatted according to the 'goimport' command. "+
+			"Reformat imports in autofix mode.",
 		[]*analysis.Analyzer{analyzer},
 		nil,
 	).WithContextSetter(func(lintCtx *linter.Context) {