Merge pull request #1320 from zhijianli88/master

k8s-ci-robot · web-flow · commit 6bcef8a92116 · 2021-01-07T10:56:53.000-08:00
📖: Fix IntoContext() documentation
diff --git a/pkg/log/log.go b/pkg/log/log.go
@@ -92,7 +92,7 @@ func FromContext(ctx context.Context, keysAndValues ...interface{}) logr.Logger
 	return log.WithValues(keysAndValues...)
 }
 
-// IntoContext takes a context and sets the logger as one of its keys.
+// IntoContext takes a context and sets the logger as one of its values.
 // Use FromContext function to retrieve the logger.
 func IntoContext(ctx context.Context, log logr.Logger) context.Context {
 	return logr.NewContext(ctx, log)

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ func FromContext(ctx context.Context, keysAndValues ...interface{}) logr.Logger`
`92`	`92`	`return log.WithValues(keysAndValues...)`
`93`	`93`	`}`
`94`	`94`
`95`		`-// IntoContext takes a context and sets the logger as one of its keys.`
	`95`	`+// IntoContext takes a context and sets the logger as one of its values.`
`96`	`96`	`// Use FromContext function to retrieve the logger.`
`97`	`97`	`func IntoContext(ctx context.Context, log logr.Logger) context.Context {`
`98`	`98`	`return logr.NewContext(ctx, log)`