add code comments for the new types and fields

pkg/kstatus/polling/polling.go

@@ -68,6 +68,10 @@ type Options struct {
 	// then each resource will be fetched when needed with GET calls.
 	UseCache bool
 
+	// CustomStatusReadersFactoryFunc, when called, provides the StatusPoller with a map of custom
+	// StatusReaders for the given GroupKinds. These will be used along with the StatusReaders shipped with this
+	// library. However, it can also be used to override these with custom StatusReaders if the returned map
+	// has a key for the given GroupKinds, e.g. apps/deployments.
 	CustomStatusReadersFactoryFunc func(engine.ClusterReader, meta.RESTMapper) map[schema.GroupKind]engine.StatusReader
 }
 

pkg/kstatus/polling/statusreaders/generic.go

@@ -14,6 +14,9 @@ import (
 	"sigs.k8s.io/cli-utils/pkg/object"
 )
 
+// StatusFunc returns the status of the given object. This func is passed into
+// NewGenericStatusReader so that the returned StatusReader can be used for custom types.
+// An example of a StatusFunc is status.Compute.
 type StatusFunc func(u *unstructured.Unstructured) (*status.Result, error)
 
 func NewGenericStatusReader(reader engine.ClusterReader, mapper meta.RESTMapper, statusFunc StatusFunc) engine.StatusReader {