Merge pull request #522 from DirectXMan12/docs/extra-manager-client-docs

📖 Note on Manager#GetClient about delegating clients
kubernetes-sigs · Jul 17, 2019 · 8f633b1 · 8f633b1
2 parents 4e3e16b + 19ac705
commit 8f633b1
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/pkg/manager/manager.go b/pkg/manager/manager.go
@@ -63,7 +63,10 @@ type Manager interface {
 	// GetScheme returns an initialized Scheme
 	GetScheme() *runtime.Scheme
 
-	// GetClient returns a client configured with the Config
+	// GetClient returns a client configured with the Config. This client may
+	// not be a fully "direct" client -- it may read from a cache, for
+	// instance.  See Options.NewClient for more information on how the default
+	// implementation works.
 	GetClient() client.Client
 
 	// GetFieldIndexer returns a client.FieldIndexer configured with the client