Merge pull request #2894 from alvaroaleman/improve-godocs

📖 Improve godocs for source
kubernetes-sigs · Jul 31, 2024 · a39ace3 · a39ace3
2 parents 8d55456 + 55eeeff
commit a39ace3
Showing 1 changed file with 2 additions and 2 deletions.
diff --git 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
 }