Skip to content

Commit

Permalink
📖 Improve godocs for source
Browse files Browse the repository at this point in the history
The godoc for `Start()` talked about an eventhander, this info is out of
date. Also mention that `Start()` must not block.
  • Loading branch information
alvaroaleman committed Jul 31, 2024
1 parent 6785442 commit 55eeeff
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pkg/source/source.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ type Source = TypedSource[reconcile.Request]
//
// Users may build their own Source implementations.
type TypedSource[request comparable] interface {
// Start is internal and should be called only by the Controller to register an EventHandler with the Informer
// to enqueue reconcile.Requests.
// Start is internal and should be called only by the Controller to start the source.
// Start must be non-blocking.
Start(context.Context, workqueue.TypedRateLimitingInterface[request]) error
}

Expand Down

0 comments on commit 55eeeff

Please sign in to comment.