Skip to content

Commit 19ac705

Browse files
committed
Note on Manager#GetClient about delegating clients
While the concrete Options struct documents delegating behavior, and the main overview documents it as well, this adds a note to manager#GetClient that it may return a non-live client, just to avoid confusion.
1 parent e826e01 commit 19ac705

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

pkg/manager/manager.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,10 @@ type Manager interface {
6363
// GetScheme returns an initialized Scheme
6464
GetScheme() *runtime.Scheme
6565

66-
// GetClient returns a client configured with the Config
66+
// GetClient returns a client configured with the Config. This client may
67+
// not be a fully "direct" client -- it may read from a cache, for
68+
// instance. See Options.NewClient for more information on how the default
69+
// implementation works.
6770
GetClient() client.Client
6871

6972
// GetFieldIndexer returns a client.FieldIndexer configured with the client

0 commit comments

Comments
 (0)