all: fix some comments
Change-Id: I2fc378bec5e2d065fd4c9d27f36ab5b47748ffd0
Reviewed-on: https://go-review.googlesource.com/c/exp/+/464237
Reviewed-by: Ian Lance Taylor <iant@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
Run-TryBot: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
diff --git a/cmd/gorelease/gorelease.go b/cmd/gorelease/gorelease.go
index 5c2342e..81ace56 100644
--- a/cmd/gorelease/gorelease.go
+++ b/cmd/gorelease/gorelease.go
@@ -1470,7 +1470,7 @@
return retracted, nil
}
-// ShortRetractionRationale returns a retraction rationale string that is safe
+// shortRetractionRationale returns a retraction rationale string that is safe
// to print in a terminal. It returns hard-coded strings if the rationale
// is empty, too long, or contains non-printable characters.
//
diff --git a/ebnf/parser.go b/ebnf/parser.go
index 7aa7a70..1551a8b 100644
--- a/ebnf/parser.go
+++ b/ebnf/parser.go
@@ -72,7 +72,7 @@
return &Token{pos, value}
}
-// ParseTerm returns nil if no term was found.
+// parseTerm returns nil if no term was found.
func (p *parser) parseTerm() (x Expression) {
pos := p.pos
diff --git a/errors/fmt/scan.go b/errors/fmt/scan.go
index f1c192a..461124b 100644
--- a/errors/fmt/scan.go
+++ b/errors/fmt/scan.go
@@ -779,7 +779,7 @@
return f
}
-// convertComplex converts the next token to a complex128 value.
+// scanComplex converts the next token to a complex128 value.
// The atof argument is a type-specific reader for the underlying type.
// If we're reading complex64, atof will parse float32s and convert them
// to float64's to avoid reproducing this code for each complex type.
diff --git a/slog/handler.go b/slog/handler.go
index cd0f911..4f2f609 100644
--- a/slog/handler.go
+++ b/slog/handler.go
@@ -195,7 +195,7 @@
}
}
-// Enabled reports whether l is greater than or equal to the
+// enabled reports whether l is greater than or equal to the
// minimum level.
func (h *commonHandler) enabled(l Level) bool {
minLevel := LevelInfo
diff --git a/slog/json_handler.go b/slog/json_handler.go
index db6c800..e43a756 100644
--- a/slog/json_handler.go
+++ b/slog/json_handler.go
@@ -48,7 +48,7 @@
return h.commonHandler.enabled(level)
}
-// With returns a new JSONHandler whose attributes consists
+// WithAttrs returns a new JSONHandler whose attributes consists
// of h's attributes followed by attrs.
func (h *JSONHandler) WithAttrs(attrs []Attr) Handler {
return &JSONHandler{commonHandler: h.commonHandler.withAttrs(attrs)}
diff --git a/slog/text_handler.go b/slog/text_handler.go
index f0fbeeb..b55c815 100644
--- a/slog/text_handler.go
+++ b/slog/text_handler.go
@@ -44,7 +44,7 @@
return h.commonHandler.enabled(level)
}
-// With returns a new TextHandler whose attributes consists
+// WithAttrs returns a new TextHandler whose attributes consists
// of h's attributes followed by attrs.
func (h *TextHandler) WithAttrs(attrs []Attr) Handler {
return &TextHandler{commonHandler: h.commonHandler.withAttrs(attrs)}
diff --git a/slog/value_safe.go b/slog/value_safe.go
index 7f50c1e..8b0a92d 100644
--- a/slog/value_safe.go
+++ b/slog/value_safe.go
@@ -48,7 +48,7 @@
return v.s
}
-// String returns a new Value for a string.
+// StringValue returns a new Value for a string.
func StringValue(value string) Value {
return Value{s: value, any: KindString}
}
diff --git a/slog/value_unsafe.go b/slog/value_unsafe.go
index 8e23058..f4276f9 100644
--- a/slog/value_unsafe.go
+++ b/slog/value_unsafe.go
@@ -57,7 +57,7 @@
}
}
-// String returns a new Value for a string.
+// StringValue returns a new Value for a string.
func StringValue(value string) Value {
hdr := (*reflect.StringHeader)(unsafe.Pointer(&value))
return Value{num: uint64(hdr.Len), any: stringptr(hdr.Data)}
@@ -92,7 +92,7 @@
return Value{num: uint64(hdr.Len), any: groupptr(hdr.Data)}
}
-// Group returns the Value's value as a []Attr.
+// group returns the Value's value as a []Attr.
// It panics if the Value's Kind is not KindGroup.
func (v Value) group() []Attr {
if sp, ok := v.any.(groupptr); ok {
