Commit fad9dec7 authored by Mike Spreitzer's avatar Mike Spreitzer

Fix comment on SharedInformer.Run

The old wording suggested that `Run` only gets the controller started. Changed the wording to make it clear that `Run` only returns after the controller is stopped.
parent c516bb51
...@@ -53,7 +53,8 @@ type SharedInformer interface { ...@@ -53,7 +53,8 @@ type SharedInformer interface {
GetStore() Store GetStore() Store
// GetController gives back a synthetic interface that "votes" to start the informer // GetController gives back a synthetic interface that "votes" to start the informer
GetController() Controller GetController() Controller
// Run starts the shared informer, which will be stopped when stopCh is closed. // Run starts and runs the shared informer, returning after it stops.
// The informer will be stopped when stopCh is closed.
Run(stopCh <-chan struct{}) Run(stopCh <-chan struct{})
// HasSynced returns true if the shared informer's store has synced. // HasSynced returns true if the shared informer's store has synced.
HasSynced() bool HasSynced() bool
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment