Skip to content

K
k3s
Unverified Commit d371d700 authored by Kubernetes Submit Queue's avatar Kubernetes Submit Queue Committed by GitHub
Browse files
Options

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(...) ```
parents 6300d580 6ce74e45
Show whitespace changes
Inline Side-by-side
Showing with 2 additions and 2 deletions
staging/src/k8s.io/apimachinery/pkg/util/wait/wait.go
View file @ d371d700
...@@ -230,13 +230,13 @@ func pollInternal(wait WaitFunc, condition ConditionFunc) error { ...@@ -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 // PollImmediate tries a condition func until it returns true, an error, or the timeout
// is reached. // 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. // will always be invoked at least once.
// //
// Some intervals may be missed if the condition takes too long or the time // Some intervals may be missed if the condition takes too long or the time
// window is too short. // 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 { func PollImmediate(interval, timeout time.Duration, condition ConditionFunc) error {
return pollImmediateInternal(poller(interval, timeout), condition) return pollImmediateInternal(poller(interval, timeout), condition)
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment