Merge pull request #118274 from kerthcet/chore/fix-the-usage-example

Chore: fix the example about how to use PollUntilContextTimeout
This commit is contained in:
Kubernetes Prow Robot 2023-05-26 06:07:04 -07:00 committed by GitHub
commit 8233635d52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -38,7 +38,7 @@ func PollUntilContextCancel(ctx context.Context, interval time.Duration, immedia
// a deadline and is equivalent to:
//
// deadlineCtx, deadlineCancel := context.WithTimeout(ctx, timeout)
// err := PollUntilContextCancel(ctx, interval, immediate, condition)
// err := PollUntilContextCancel(deadlineCtx, interval, immediate, condition)
//
// The deadline context will be cancelled if the Poll succeeds before the timeout, simplifying
// inline usage. All other behavior is identical to PollUntilContextCancel.