From: Jonathan Amsterdam <jba@google.com>
Date: Tue, 21 Mar 2023 12:57:43 +0000 (-0400)
Subject: log/slog: clarify Logger.WithGroup doc
X-Git-Tag: go1.21rc1~1204
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=eedd97d5fd9d7b773dc7b1b8d7e00e137da091bb;p=gostls13.git

log/slog: clarify Logger.WithGroup doc

Make it clear that "qualified by the given name" doesn't imply
any particular implementation, but depends on how the Handler
treats groups.

Updates golang/go#56345.

Change-Id: Idf52553108bc1a7d2091a06cc4fc4cc0fc52cc14
Reviewed-on: https://go-review.googlesource.com/c/go/+/478056
Reviewed-by: Alan Donovan <adonovan@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Jonathan Amsterdam <jba@google.com>
---

diff --git a/src/log/slog/logger.go b/src/log/slog/logger.go
index fc734b2ba6..f58add9af9 100644
--- a/src/log/slog/logger.go
+++ b/src/log/slog/logger.go
@@ -109,6 +109,8 @@ func (l *Logger) With(args ...any) *Logger {
 
 // WithGroup returns a new Logger that starts a group. The keys of all
 // attributes added to the Logger will be qualified by the given name.
+// (How that qualification happens depends on the [Handler.WithGroup]
+// method of the Logger's Handler.)
 // The new Logger shares the old Logger's context.
 //
 // The new Logger's handler is the result of calling WithGroup on the receiver's