From 91ee58050f8e0ea61eacb75486584436ca6f4829 Mon Sep 17 00:00:00 2001 From: Tobias Klauser Date: Thu, 27 Apr 2023 16:44:24 +0200 Subject: [PATCH] wait: fix PollUntilContextTimeout godoc comment PollUntilContextTimeout's godoc comment references itself. Adjust the godoc comment to instead reference PollUntilContextCancel to which it is identical apart from the deadline context. --- staging/src/k8s.io/apimachinery/pkg/util/wait/poll.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/staging/src/k8s.io/apimachinery/pkg/util/wait/poll.go b/staging/src/k8s.io/apimachinery/pkg/util/wait/poll.go index 53d8592df75..b2c106920e3 100644 --- a/staging/src/k8s.io/apimachinery/pkg/util/wait/poll.go +++ b/staging/src/k8s.io/apimachinery/pkg/util/wait/poll.go @@ -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()