]> Cypherpunks repositories - gostls13.git/commitdiff
log/slog: fix level doc on handlers
authorJonathan Amsterdam <jba@google.com>
Sun, 8 Jun 2025 12:49:25 +0000 (08:49 -0400)
committerGopher Robot <gobot@golang.org>
Mon, 9 Jun 2025 16:04:58 +0000 (09:04 -0700)
Fixed doc on {JSON,Text}Handler.Handle: the level is never omitted.

Fixes #73943.

Change-Id: Ia470cbe5d713ab18dd80eeea1c0ab8f5e6d30f3f
Reviewed-on: https://go-review.googlesource.com/c/go/+/680055
Auto-Submit: Jonathan Amsterdam <jba@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
Reviewed-by: Sean Liao <sean@liao.dev>
src/log/slog/json_handler.go
src/log/slog/text_handler.go

index da3eae1a8ec0d35bd35548f794f1f22d4d3bc7c8..f139c5413912bf2610cf802e8e175d38256ca331 100644 (file)
@@ -63,9 +63,7 @@ func (h *JSONHandler) WithGroup(name string) Handler {
 // Otherwise, the key is "time"
 // and the value is output as with json.Marshal.
 //
-// If the Record's level is zero, the level is omitted.
-// Otherwise, the key is "level"
-// and the value of [Level.String] is output.
+// The level's key is "level" and its value is the result of calling [Level.String].
 //
 // If the AddSource option is set and source information is available,
 // the key is "source", and the value is a record of type [Source].
index 6819e633bb713f20bce1399a06cb773ffff51bc3..5a0d0a4a7ed42b5b0f42bdff8adbdc6b565fb02a 100644 (file)
@@ -62,9 +62,7 @@ func (h *TextHandler) WithGroup(name string) Handler {
 // Otherwise, the key is "time"
 // and the value is output in RFC3339 format with millisecond precision.
 //
-// If the Record's level is zero, the level is omitted.
-// Otherwise, the key is "level"
-// and the value of [Level.String] is output.
+// The level's key is "level" and its value is the result of calling [Level.String].
 //
 // If the AddSource option is set and source information is available,
 // the key is "source" and the value is output as FILE:LINE.