Skip to content

Commit 55eeeff

Browse files
committed
📖 Improve godocs for source
The godoc for `Start()` talked about an eventhander, this info is out of date. Also mention that `Start()` must not block.
1 parent 6785442 commit 55eeeff

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

pkg/source/source.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ type Source = TypedSource[reconcile.Request]
5353
//
5454
// Users may build their own Source implementations.
5555
type TypedSource[request comparable] interface {
56-
// Start is internal and should be called only by the Controller to register an EventHandler with the Informer
57-
// to enqueue reconcile.Requests.
56+
// Start is internal and should be called only by the Controller to start the source.
57+
// Start must be non-blocking.
5858
Start(context.Context, workqueue.TypedRateLimitingInterface[request]) error
5959
}
6060

0 commit comments

Comments
 (0)