Address comments.

Author: godwinpang

pkg/config/controller.go

@@ -60,7 +60,7 @@ type Controller struct {
 	// Defaults to true, which means the controller will use leader election.
 	NeedLeaderElection *bool
 
-	// EnableWarmup indicates whether the controller needs to use warm up.
+	// NeedWarmup indicates whether the controller needs to use warm up.
 	// Defaults to false, which means the controller will not use warm up.
 	NeedWarmup *bool
 

pkg/controller/controller.go

@@ -94,10 +94,11 @@ type TypedOptions[request comparable] struct {
 	// Note: This flag is disabled by default until a future version. It's currently in beta.
 	UsePriorityQueue *bool
 
-	// NeedWarmup specifies whether the controller should start its sources
-	// when the manager is not the leader.
-	// Defaults to false, which means that the controller will wait for leader election to start
-	// before starting sources.
+	// NeedWarmup specifies whether the controller should start its sources when the manager is not
+	// the leader. When set to true, the controller will not restart its sources when/if it
+	// transitions to be leader.
+	//
+	// Defaults to false.
 	NeedWarmup *bool
 }
 

pkg/manager/manager.go

@@ -314,9 +314,11 @@ type LeaderElectionRunnable interface {
 	NeedLeaderElection() bool
 }
 
-// WarmupRunnable knows if a Runnable should be a warmup runnable.
+// WarmupRunnable knows if a Runnable should be a warmup runnable. A warmup runnable is a runnable
+// that should be run when the manager is started, but before the leader election is acquired.
+// The expectation is that it will block startup until the warmup runnables have completed.
 type WarmupRunnable interface {
-	// Warmup returns true if the Runnable should be run as warmup.
+	// Warmup is called when the manager is started, but before the leader election is acquired.
 	Warmup(context.Context) error
 }