Skip to content

Commit

Permalink
Note on Manager#GetClient about delegating clients
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
DirectXMan12 committed Jul 17, 2019
1 parent e826e01 commit 19ac705
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pkg/manager/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 19ac705

Please sign in to comment.