Skip to content

Commit d70754f

Browse files
Merge pull request #128380 from pohly/log-TODO-logcheck
apiserver: avoid TODO in public docs Kubernetes-commit: 432a9af0fbcea0fec3eed631f628c8da71a32c45
2 parents a447138 + 230b216 commit d70754f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

pkg/util/runtime/runtime.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ var PanicHandlers = []func(context.Context, interface{}){logPanic}
4545
//
4646
// E.g., you can provide one or more additional handlers for something like shutting down go routines gracefully.
4747
//
48-
// TODO(pohly): logcheck:context // HandleCrashWithContext should be used instead of HandleCrash in code which supports contextual logging.
48+
// Contextual logging: HandleCrashWithContext should be used instead of HandleCrash in code which supports contextual logging.
4949
func HandleCrash(additionalHandlers ...func(interface{})) {
5050
if r := recover(); r != nil {
5151
additionalHandlersWithContext := make([]func(context.Context, interface{}), len(additionalHandlers))
@@ -146,7 +146,7 @@ type ErrorHandler func(ctx context.Context, err error, msg string, keysAndValues
146146
// is preferable to logging the error - the default behavior is to log but the
147147
// errors may be sent to a remote server for analysis.
148148
//
149-
// TODO(pohly): logcheck:context // HandleErrorWithContext should be used instead of HandleError in code which supports contextual logging.
149+
// Contextual logging: HandleErrorWithContext should be used instead of HandleError in code which supports contextual logging.
150150
func HandleError(err error) {
151151
// this is sometimes called with a nil error. We probably shouldn't fail and should do nothing instead
152152
if err == nil {

0 commit comments

Comments
 (0)