internal/telemetry/log: correct the docstring for Error
Change-Id: I8077bbdd6f011087f7988fbf04c97c13575afec0
Reviewed-on: https://go-review.googlesource.com/c/tools/+/215741
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
diff --git a/internal/telemetry/log/log.go b/internal/telemetry/log/log.go
index f6c3f44..b4f2c70 100644
--- a/internal/telemetry/log/log.go
+++ b/internal/telemetry/log/log.go
@@ -35,8 +35,9 @@
})
}
-// Print takes a message and a tag list and combines them into a single tag
-// list before delivering them to the loggers.
+// Error takes a message and a tag list and combines them into a single tag
+// list before delivering them to the loggers. It captures the error in the
+// delivered event.
func Error(ctx context.Context, message string, err error, tags ...tag.Tagger) {
if err == nil {
err = errorString(message)
