1
0
mirror of https://github.com/golang/go synced 2024-11-18 19:14:40 -07:00

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>
This commit is contained in:
Rob Findley 2020-01-21 16:25:13 -05:00 committed by Robert Findley
parent b3205ff6ff
commit 29f64efd55

View File

@ -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 // Error takes a message and a tag list and combines them into a single tag
// list before delivering them to the loggers. // 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) { func Error(ctx context.Context, message string, err error, tags ...tag.Tagger) {
if err == nil { if err == nil {
err = errorString(message) err = errorString(message)