chore: give the exported function a comment

Signed-off-by: aaronschweig <[email protected]>

Author: aaronschweig

pkg/cache/defaulting_test.go

@@ -427,7 +427,7 @@ func TestDefaultOpts(t *testing.T) {
 			}
 
 			// We cannot reference kcp.NewInformerWithClusterIndexes due to import cycle.
-			defaulted.NewInformerFunc = nil
+			defaulted.NewInformer = nil
 
 			if diff := tc.verification(defaulted); diff != "" {
 				t.Errorf("expected config differs from actual: %s", diff)

pkg/client/interfaces.go

@@ -18,14 +18,11 @@ package client
 
 import (
 	"context"
-	"time"
 
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
-	"k8s.io/apimachinery/pkg/runtime/schema"
-	"k8s.io/client-go/tools/cache"
-
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/watch"
 )
@@ -46,10 +43,6 @@ type Patch interface {
 	Data(obj Object) ([]byte, error)
 }
 
-// NewInformerFunc describes a function that creates SharedIndexInformers.
-// Its signature matches cache.NewSharedIndexInformer from client-go.
-type NewInformerFunc func(cache.ListerWatcher, runtime.Object, time.Duration, cache.Indexers) cache.SharedIndexInformer
-
 // TODO(directxman12): is there a sane way to deal with get/delete options?
 
 // Reader knows how to read and list Kubernetes objects.

pkg/kcp/wrappers.go

@@ -79,7 +79,7 @@ func NewClusterAwareCache(config *rest.Config, opts cache.Options) (cache.Cache,
 	c := rest.CopyConfig(config)
 	c.Host = strings.TrimSuffix(c.Host, "/") + "/clusters/*"
 
-	opts.NewInformerFunc = NewInformerWithClusterIndexes
+	opts.NewInformer = NewInformerWithClusterIndexes
 	return cache.New(c, opts)
 }
 
@@ -161,6 +161,7 @@ func NewClusterAwareHTTPClient(config *rest.Config) (*http.Client, error) {
 	return httpClient, nil
 }
 
+// NewClusterAwareClientWithWatch returns a new WithWatch with a cluster aware client underneath.
 func NewClusterAwareClientWithWatch(config *rest.Config, options client.Options) (client.WithWatch, error) {
 	opts, err := applyClientOptions(config, options)
 	if err != nil {