gopls/internal/lsp/analysis/unusedparams: document the blank identifier

findleyr · findleyr · commit 914b218fc34e · 2023-08-31T18:24:30.000Z
Improve documentation around the blank identifier in the unusedparams analyzer. Referring to "underscored" names is confusing, as that may reasonably be interpreted as referring to names like "_foo". Fixes golang/go#60682 Change-Id: I90e4bc47fad230c5843e69395c055ebe77ad498a Reviewed-on: https://go-review.googlesource.com/c/tools/+/524835 TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Robert Findley <rfindley@google.com> Reviewed-by: Alan Donovan <adonovan@google.com>
diff --git a/gopls/doc/analyzers.md b/gopls/doc/analyzers.md
@@ -632,7 +632,7 @@ any parameters that are not being used.
 
 To reduce false positives it ignores:
 - methods
-- parameters that do not have a name or are underscored
+- parameters that do not have a name or have the name '_' (the blank identifier)
 - functions in test files
 - functions with empty bodies or those with just a return stmt
 
diff --git a/gopls/internal/lsp/analysis/unusedparams/unusedparams.go b/gopls/internal/lsp/analysis/unusedparams/unusedparams.go
@@ -24,7 +24,7 @@ any parameters that are not being used.
 
 To reduce false positives it ignores:
 - methods
-- parameters that do not have a name or are underscored
+- parameters that do not have a name or have the name '_' (the blank identifier)
 - functions in test files
 - functions with empty bodies or those with just a return stmt`
 
diff --git a/gopls/internal/lsp/source/api_json.go b/gopls/internal/lsp/source/api_json.go
