Skip to content

Commit

Permalink
log/slog: change XXXCtx functions to XXXContext
Browse files Browse the repository at this point in the history
Fixes golang#61200.

Change-Id: I3071dbf673bcd2d24e62644b40d481c953703978
Reviewed-on: https://go-review.googlesource.com/c/go/+/508195
Run-TryBot: Jonathan Amsterdam <jba@google.com>
Reviewed-by: Russ Cox <rsc@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
  • Loading branch information
jba authored and eric committed Sep 7, 2023
1 parent 503c22e commit fa84f38
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 26 deletions.
4 changes: 2 additions & 2 deletions src/log/slog/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,9 @@ argument, as do their corresponding top-level functions.
Although the convenience methods on Logger (Info and so on) and the
corresponding top-level functions do not take a context, the alternatives ending
in "Ctx" do. For example,
in "Context" do. For example,
slog.InfoCtx(ctx, "message")
slog.InfoContext(ctx, "message")
It is recommended to pass a context to an output method if one is available.
Expand Down
32 changes: 16 additions & 16 deletions src/log/slog/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ func (l *Logger) Debug(msg string, args ...any) {
l.log(nil, LevelDebug, msg, args...)
}

// DebugCtx logs at LevelDebug with the given context.
func (l *Logger) DebugCtx(ctx context.Context, msg string, args ...any) {
// DebugContext logs at LevelDebug with the given context.
func (l *Logger) DebugContext(ctx context.Context, msg string, args ...any) {
l.log(ctx, LevelDebug, msg, args...)
}

Expand All @@ -178,8 +178,8 @@ func (l *Logger) Info(msg string, args ...any) {
l.log(nil, LevelInfo, msg, args...)
}

// InfoCtx logs at LevelInfo with the given context.
func (l *Logger) InfoCtx(ctx context.Context, msg string, args ...any) {
// InfoContext logs at LevelInfo with the given context.
func (l *Logger) InfoContext(ctx context.Context, msg string, args ...any) {
l.log(ctx, LevelInfo, msg, args...)
}

Expand All @@ -188,8 +188,8 @@ func (l *Logger) Warn(msg string, args ...any) {
l.log(nil, LevelWarn, msg, args...)
}

// WarnCtx logs at LevelWarn with the given context.
func (l *Logger) WarnCtx(ctx context.Context, msg string, args ...any) {
// WarnContext logs at LevelWarn with the given context.
func (l *Logger) WarnContext(ctx context.Context, msg string, args ...any) {
l.log(ctx, LevelWarn, msg, args...)
}

Expand All @@ -198,8 +198,8 @@ func (l *Logger) Error(msg string, args ...any) {
l.log(nil, LevelError, msg, args...)
}

// ErrorCtx logs at LevelError with the given context.
func (l *Logger) ErrorCtx(ctx context.Context, msg string, args ...any) {
// ErrorContext logs at LevelError with the given context.
func (l *Logger) ErrorContext(ctx context.Context, msg string, args ...any) {
l.log(ctx, LevelError, msg, args...)
}

Expand Down Expand Up @@ -250,8 +250,8 @@ func Debug(msg string, args ...any) {
Default().log(nil, LevelDebug, msg, args...)
}

// DebugCtx calls Logger.DebugCtx on the default logger.
func DebugCtx(ctx context.Context, msg string, args ...any) {
// DebugContext calls Logger.DebugContext on the default logger.
func DebugContext(ctx context.Context, msg string, args ...any) {
Default().log(ctx, LevelDebug, msg, args...)
}

Expand All @@ -260,8 +260,8 @@ func Info(msg string, args ...any) {
Default().log(nil, LevelInfo, msg, args...)
}

// InfoCtx calls Logger.InfoCtx on the default logger.
func InfoCtx(ctx context.Context, msg string, args ...any) {
// InfoContext calls Logger.InfoContext on the default logger.
func InfoContext(ctx context.Context, msg string, args ...any) {
Default().log(ctx, LevelInfo, msg, args...)
}

Expand All @@ -270,8 +270,8 @@ func Warn(msg string, args ...any) {
Default().log(nil, LevelWarn, msg, args...)
}

// WarnCtx calls Logger.WarnCtx on the default logger.
func WarnCtx(ctx context.Context, msg string, args ...any) {
// WarnContext calls Logger.WarnContext on the default logger.
func WarnContext(ctx context.Context, msg string, args ...any) {
Default().log(ctx, LevelWarn, msg, args...)
}

Expand All @@ -280,8 +280,8 @@ func Error(msg string, args ...any) {
Default().log(nil, LevelError, msg, args...)
}

// ErrorCtx calls Logger.ErrorCtx on the default logger.
func ErrorCtx(ctx context.Context, msg string, args ...any) {
// ErrorContext calls Logger.ErrorContext on the default logger.
func ErrorContext(ctx context.Context, msg string, args ...any) {
Default().log(ctx, LevelError, msg, args...)
}

Expand Down
16 changes: 8 additions & 8 deletions src/log/slog/logger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -393,14 +393,14 @@ func TestContext(t *testing.T) {
f func(context.Context, string, ...any)
wantLevel Level
}{
{l.DebugCtx, LevelDebug},
{l.InfoCtx, LevelInfo},
{l.WarnCtx, LevelWarn},
{l.ErrorCtx, LevelError},
{DebugCtx, LevelDebug},
{InfoCtx, LevelInfo},
{WarnCtx, LevelWarn},
{ErrorCtx, LevelError},
{l.DebugContext, LevelDebug},
{l.InfoContext, LevelInfo},
{l.WarnContext, LevelWarn},
{l.ErrorContext, LevelError},
{DebugContext, LevelDebug},
{InfoContext, LevelInfo},
{WarnContext, LevelWarn},
{ErrorContext, LevelError},
} {
h.clear()
ctx := context.WithValue(context.Background(), "L", test.wantLevel)
Expand Down

0 comments on commit fa84f38

Please sign in to comment.