Skip to content

docs: align RandomizationFactor comment with field naming style #654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jjpinto wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: align RandomizationFactor comment with field naming style #654

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions message/router/middleware/retry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ type Retry struct {
// MaxElapsedTime sets the time limit of how long retries will be attempted. Disabled if 0.
MaxElapsedTime time.Duration
// RandomizationFactor randomizes the spread of the backoff times within the interval of:
// [currentInterval * (1 - randomization_factor), currentInterval * (1 + randomization_factor)].
// [currentInterval * (1 - RandomizationFactor), currentInterval * (1 + RandomizationFactor)].
RandomizationFactor float64

// OnRetryHook is an optional function that will be executed on each retry attempt.
Expand Down Expand Up @@ -73,7 +73,7 @@ func (r Retry) Middleware(h message.HandlerFunc) message.HandlerFunc {

maxElapsedBackoff := backoff.WithMaxElapsedTime(r.MaxElapsedTime)

// notification: called on a failed retry attempt.
// notification is called on a failed retry attempt.
notification := func(err error, delay time.Duration) {
if r.Logger != nil {
r.Logger.Error("Error occurred, retrying", err, watermill.LogFields{
Expand All @@ -91,7 +91,7 @@ func (r Retry) Middleware(h message.HandlerFunc) message.HandlerFunc {
return nil, originalCtx.Err()
default:
if r.ResetContextOnRetry {
// message is passed as a pointer, so it's context can be canceled
// message is passed as a pointer, so its context can be canceled
// by the previous attempts -> it will break retries, because any
// underlying logic that relies on the context will fail.
// see more: https://github.com/ThreeDotsLabs/watermill/issues/467
Expand Down