What happened?

The comments for NewExponentialBackoffManager read:

// NewExponentialBackoffManager returns a manager for managing exponential backoff. Each backoff is jittered and
// backoff will not exceed the given max. If the backoff is not called within resetDuration, the backoff is reset.
// This backoff manager is used to reduce load during upstream unhealthiness.
//
// Deprecated: Will be removed when the legacy Poll methods are removed. Callers should construct a
// Backoff struct, use DelayWithReset() to get a DelayFunc that periodically resets itself, and then
// invoke Timer() when calling wait.BackoffUntil.
//
// Instead of:
//
//	bm := wait.NewExponentialBackoffManager(init, max, reset, factor, jitter, clock)
//	...
//	wait.BackoffUntil(..., bm.Backoff, ...)
//
// Use:
//
//	delayFn := wait.Backoff{
//	  Duration: init,
//	  Cap:      max,
//	  Steps:    int(math.Ceil(float64(max) / float64(init))), // now a required argument
//	  Factor:   factor,
//	  Jitter:   jitter,
//	}.DelayWithReset(reset, clock)
//	wait.BackoffUntil(..., delayFn.Timer(), ...)

In particular, the comments are asking us to use wait.BackoffUntil(..., delayFn.Timer(), ...).

This does not seem possible, given that the second parameter for wait.BackoffUntil is of type BackoffManager (interface), while delayFn.Timer() returns a Timer interface. Maybe the author intended to update the definition of BackoffUntil but ended up not doing so for backwards-compatible reasons.

Even wait.BackoffUntil(..., bm.Backoff, ...) does not seem correct.

The documentation for this package needs to be revisited. At the moment, anyone using the latest version of this package would get deprecation warnings from linters, with no remediation possible.

What did you expect to happen?

The documentation should be correct.

How can we reproduce it (as minimally and precisely as possible)?

N/A

Anything else we need to know?

No response

Kubernetes version

K8s v1.27.1, but also master branch

Cloud provider

N/A

OS version

# On Linux:
$ cat /etc/os-release
# paste output here
$ uname -a
# paste output here

# On Windows:
C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture
# paste output here

Install tools

Container runtime (CRI) and version (if applicable)

Related plugins (CNI, CSI, ...) and versions (if applicable)