Merge pull request #117650 from tklauser/wait-correct-comment

wait: fix PollUntilContextTimeout godoc comment
This commit is contained in:
Kubernetes Prow Robot 2023-05-11 10:59:14 -07:00 committed by GitHub
commit 7522cb2c1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

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