Skip to content

Commit 7f7d703

Browse files
authored
Update JobSnooze docstring to say that Attempt does not increment (#1238)
1 parent c6d65e5 commit 7f7d703

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

error.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ func JobCancel(err error) error {
2828
type JobSnoozeError = rivertype.JobSnoozeError
2929

3030
// JobSnooze can be returned from a Worker's Work method to cause the job to be
31-
// tried again after the specified duration. This also has the effect of
32-
// incrementing the job's MaxAttempts by 1, meaning that jobs can be repeatedly
33-
// snoozed without ever being discarded.
31+
// tried again after the specified duration. This will not increment the job's
32+
// Attempt count, meaning that jobs can be repeatedly snoozed without ever being
33+
// discarded.
3434
//
3535
// A special duration of zero can be used to make the job immediately available
3636
// to be reworked. This may be useful in cases like where a long-running job is

0 commit comments

Comments
 (0)