Merge pull request #47 from lestrrat-go/update-example

Update example doc
lestrrat-go · Oct 9, 2024 · 7382973 · 7382973
2 parents fbcf0c4 + 5bccc4f
commit 7382973
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/client_example_test.go b/client_example_test.go
@@ -72,7 +72,8 @@ func ExampleClient() {
 
 	// Add the resource to the controller, so that it starts fetching.
 	// By default, a call to `Add()` will block until the first fetch
-	// succeeds, but you can skip this if you specify the `WithWaitReady(false)`
+	// succeeds, via an implicit call to `r.Ready()`
+	// You can change this behavior if you specify the `WithWaitReady(false)`
 	// option.
 	ctrl.Add(ctx, r)