Merge pull request #65026 from spew/fix-poll-immediate-docs

Automatic merge from submit-queue (batch tested with PRs 65265, 64822, 65026, 65019, 65077). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Correct several mistakes in the comments/doc for PollImmediate. **What this PR does / why we need it**: The wait.PollImmediate(...) docs refer to the Poll(...) function by mistake which is confusing. This PR fixes that issue. **Release note**: ```release-note Corrected a mistake in the documentation for wait.PollImmediate(...) ```

Merge pull request #65026 from spew/fix-poll-immediate-docs
d371d700 · Kubernetes Submit Queue · GitHub · 6300d580 · 6ce74e45 · d371d700
Unverified Commit d371d700 authored Jun 21, 2018 by Kubernetes Submit Queue Committed by GitHub Jun 21, 2018
Hide whitespace changes
Inline Side-by-side

Showing with 2 additions and 2 deletions

wait.go staging/src/k8s.io/apimachinery/pkg/util/wait/wait.go +2 -2

No files found.
--- a/staging/src/k8s.io/apimachinery/pkg/util/wait/wait.go
+++ b/staging/src/k8s.io/apimachinery/pkg/util/wait/wait.go
@@ -230,13 +230,13 @@ func pollInternal(wait WaitFunc, condition ConditionFunc) error {
 // PollImmediate tries a condition func until it returns true, an error, or the timeout
 // is reached.
 //
-// Poll always checks 'condition' before waiting for the interval. 'condition'
+// PollImmediate always checks 'condition' before waiting for the interval. 'condition'
 // will always be invoked at least once.
 //
 // Some intervals may be missed if the condition takes too long or the time
 // window is too short.
 //
-// If you want to Poll something forever, see PollInfinite.
+// If you want to immediately Poll something forever, see PollImmediateInfinite.
 func PollImmediate(interval, timeout time.Duration, condition ConditionFunc) error {
 	return pollImmediateInternal(poller(interval, timeout), condition)
 }