From 55eeeff72e7dc77862eb7917f2eb0da0e952ec92 Mon Sep 17 00:00:00 2001 From: Alvaro Aleman Date: Tue, 30 Jul 2024 21:43:30 -0400 Subject: [PATCH] :book: 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. --- pkg/source/source.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/source/source.go b/pkg/source/source.go index 3aaf952cd2..267a6470b8 100644 --- a/pkg/source/source.go +++ b/pkg/source/source.go @@ -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 }