github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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
parent f7cfb5f02f 7d2e1888f8
commit 8233635d52
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
staging/src/k8s.io/apimachinery/pkg/util/wait/poll.go
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.