Skip to content

Commit 0b3914d

Browse files
adonovangopherbot
authored andcommitted
go/analysis/passes/defers: rename Analyzer.Name to "defers"
...to match package name and avoid a minor nuisance. Change-Id: Ifb16c6ea60cf349be36ae35eee281e95423ca24d Reviewed-on: https://go-review.googlesource.com/c/tools/+/527736 LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: Robert Findley <[email protected]> Auto-Submit: Alan Donovan <[email protected]> gopls-CI: kokoro <[email protected]>
1 parent ad827af commit 0b3914d

File tree

6 files changed

+15
-13
lines changed

6 files changed

+15
-13
lines changed

go/analysis/passes/defers/defer.go renamed to go/analysis/passes/defers/defers.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@ import (
1919
//go:embed doc.go
2020
var doc string
2121

22-
// Analyzer is the defer analyzer.
22+
// Analyzer is the defers analyzer.
2323
var Analyzer = &analysis.Analyzer{
24-
Name: "defer",
24+
Name: "defers",
2525
Requires: []*analysis.Analyzer{inspect.Analyzer},
26-
Doc: analysisutil.MustExtractDoc(doc, "defer"),
26+
URL: "https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/defers",
27+
Doc: analysisutil.MustExtractDoc(doc, "defers"),
2728
Run: run,
2829
}
2930

go/analysis/passes/defers/doc.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
// Package defers defines an Analyzer that checks for common mistakes in defer
66
// statements.
77
//
8-
// # Analyzer defer
8+
// # Analyzer defers
99
//
10-
// defer: report common mistakes in defer statements
10+
// defers: report common mistakes in defer statements
1111
//
12-
// The defer analyzer reports a diagnostic when a defer statement would
12+
// The defers analyzer reports a diagnostic when a defer statement would
1313
// result in a non-deferred call to time.Since, as experience has shown
1414
// that this is nearly always a mistake.
1515
//

gopls/doc/analyzers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,11 @@ errors is discouraged.
108108

109109
**Enabled by default.**
110110

111-
## **defer**
111+
## **defers**
112112

113113
report common mistakes in defer statements
114114

115-
The defer analyzer reports a diagnostic when a defer statement would
115+
The defers analyzer reports a diagnostic when a defer statement would
116116
result in a non-deferred call to time.Since, as experience has shown
117117
that this is nearly always a mistake.
118118

gopls/doc/generate_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ func TestGenerated(t *testing.T) {
2323
t.Fatal(err)
2424
}
2525
if !ok {
26-
t.Error("documentation needs updating. Run: cd gopls && go generate ./doc")
26+
t.Error("documentation needs updating. Run: cd gopls && go generate")
2727
}
2828
}

gopls/internal/lsp/source/api_json.go

Lines changed: 5 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)