github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-17 15:50:10 +00:00
Code Issues Projects Releases Wiki Activity

wait: fix PollUntilContextTimeout godoc comment

Browse Source 
PollUntilContextTimeout's godoc comment references itself. Adjust the
godoc comment to instead reference PollUntilContextCancel to which it
is identical apart from the deadline context.
This commit is contained in:
Tobias Klauser 2023-04-27 16:44:24 +02:00
parent 926bb80f5d
commit 91ee58050f
No known key found for this signature in database
GPG Key ID: 6F5040074CCC0D04
1 changed files with 1 additions and 1 deletions
Show Stats 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

@ -41,7 +41,7 @@ func PollUntilContextCancel(ctx context.Context, interval time.Duration, immedia
// err := PollUntilContextCancel(ctx, 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 PollUntilContextTimeout.
// inline usage. All other behavior is identical to PollUntilContextCancel.
func PollUntilContextTimeout(ctx context.Context, interval, timeout time.Duration, immediate bool, condition ConditionWithContextFunc) error {
deadlineCtx, deadlineCancel := context.WithTimeout(ctx, timeout)
defer deadlineCancel()