Skip to content

Commit 9d5ddfb

Browse files
committed
Clarify comment on Warmup.
1 parent 89f5479 commit 9d5ddfb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

pkg/manager/manager.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,11 +315,11 @@ type LeaderElectionRunnable interface {
315315
}
316316

317317
// warmupRunnable knows if a Runnable requires warmup. A warmup runnable is a runnable
318-
// that should be run when the manager is started, but before the leader election is acquired.
318+
// that should be run when the manager is started but before it becomes leader.
319319
// Note: Implementing this interface is only useful when LeaderElection can be enabled, as the
320320
// behavior when leaderelection is not enabled is to run LeaderElectionRunnables immediately.
321321
type warmupRunnable interface {
322-
// Warmup is the implementation of the warmup runnable.
322+
// Warmup will be called when the manager is started but before it becomes leader.
323323
Warmup(context.Context) error
324324

325325
// WaitForWarmupComplete is a blocking function that waits for the warmup to be completed. It

0 commit comments

Comments
 (0)