From 29f64efd556a7cd6e01b0b1c1058fe8e56446fba Mon Sep 17 00:00:00 2001 From: Rob Findley Date: Tue, 21 Jan 2020 16:25:13 -0500 Subject: [PATCH] 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 --- internal/telemetry/log/log.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/internal/telemetry/log/log.go b/internal/telemetry/log/log.go index f6c3f4435b1..b4f2c70a21b 100644 --- a/internal/telemetry/log/log.go +++ b/internal/telemetry/log/log.go @@ -35,8 +35,9 @@ func Print(ctx context.Context, message string, tags ...tag.Tagger) { }) } -// 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)