Improve docs for client-go warning handlers

shengnuo · Aug 29, 2020 · b0573d5 · b0573d5
1 parent d9789c4
commit b0573d5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/staging/src/k8s.io/client-go/rest/config.go b/staging/src/k8s.io/client-go/rest/config.go
@@ -125,6 +125,7 @@ type Config struct {
 
 	// WarningHandler handles warnings in server responses.
 	// If not set, the default warning handler is used.
+	// See documentation for SetDefaultWarningHandler() for details.
 	WarningHandler WarningHandler
 
 	// The maximum length of time to wait before giving up on a server request. A value of zero means no timeout.

diff --git a/staging/src/k8s.io/client-go/rest/warnings.go b/staging/src/k8s.io/client-go/rest/warnings.go
@@ -38,8 +38,11 @@ var (
 	defaultWarningHandlerLock sync.RWMutex
 )
 
-// SetDefaultWarningHandler sets the default handler client uses when warning headers are encountered.
-// By default, warnings are printed to stderr.
+// SetDefaultWarningHandler sets the default handler clients use when warning headers are encountered.
+// By default, warnings are logged. Several built-in implementations are provided:
+//  - NoWarnings suppresses warnings.
+//  - WarningLogger logs warnings.
+//  - NewWarningWriter() outputs warnings to the provided writer.
 func SetDefaultWarningHandler(l WarningHandler) {
 	defaultWarningHandlerLock.Lock()
 	defer defaultWarningHandlerLock.Unlock()