internal/lsp,internal/telemetry: correct stale docstrings
Several docstrings reference earlier names for the symbols they
document. This CL corrects those that I noticed while reading the lsp
code.
Change-Id: I1968459feff7011e070333c99eb149e72d3302de
Reviewed-on: https://go-review.googlesource.com/c/tools/+/214801
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
diff --git a/internal/lsp/server.go b/internal/lsp/server.go
index 7c94c45..0d25328 100644
--- a/internal/lsp/server.go
+++ b/internal/lsp/server.go
@@ -44,8 +44,8 @@
return RunServerOnAddress(ctx, cache, fmt.Sprintf(":%v", port), h)
}
-// RunServerOnPort starts an LSP server on the given port and does not exit.
-// This function exists for debugging purposes.
+// RunServerOnAddress starts an LSP server on the given address and does not
+// exit. This function exists for debugging purposes.
func RunServerOnAddress(ctx context.Context, cache source.Cache, addr string, h func(ctx context.Context, s *Server)) error {
ln, err := net.Listen("tcp", addr)
if err != nil {
diff --git a/internal/lsp/source/options.go b/internal/lsp/source/options.go
index a2eeb0b..1584981 100644
--- a/internal/lsp/source/options.go
+++ b/internal/lsp/source/options.go
@@ -215,7 +215,7 @@
SynopsisDocumentation
FullDocumentation
- // structured is an experimental setting that returns a structured hover format.
+ // Structured is an experimental setting that returns a structured hover format.
// This format separates the signature from the documentation, so that the client
// can do more manipulation of these fields.
//
diff --git a/internal/telemetry/stats/stats.go b/internal/telemetry/stats/stats.go
index f3d3ede..6575803 100644
--- a/internal/telemetry/stats/stats.go
+++ b/internal/telemetry/stats/stats.go
@@ -24,7 +24,7 @@
subscribers []Int64Subscriber
}
-// Int64Measure is used to record floating point values.
+// Float64Measure is used to record floating point values.
type Float64Measure struct {
name string
description string
diff --git a/internal/telemetry/tag.go b/internal/telemetry/tag.go
index 6d7e11d..54c6102 100644
--- a/internal/telemetry/tag.go
+++ b/internal/telemetry/tag.go
@@ -26,7 +26,7 @@
fmt.Fprintf(f, `%v="%v"`, t.Key, t.Value)
}
-// Get returns the tag unmodified.
+// Tag returns the tag unmodified.
// It makes Key conform to the Tagger interface.
func (t Tag) Tag(ctx context.Context) Tag {
return t
diff --git a/internal/telemetry/unit/unit.go b/internal/telemetry/unit/unit.go
index a904a28..596a5c7 100644
--- a/internal/telemetry/unit/unit.go
+++ b/internal/telemetry/unit/unit.go
@@ -10,10 +10,10 @@
type Unit string
const (
- // UnitDimensionless indicates that a measure has no specified units.
+ // Dimensionless indicates that a measure has no specified units.
Dimensionless = "1"
- // UnitBytes indicates that that a measure is recording number of bytes.
+ // Bytes indicates that that a measure is recording number of bytes.
Bytes = "By"
- // UnitMilliseconds indicates that a measure is recording a duration in milliseconds.
+ // Milliseconds indicates that a measure is recording a duration in milliseconds.
Milliseconds = "ms"
)
