aboutsummaryrefslogtreecommitdiffstats
path: root/activejob
diff options
context:
space:
mode:
authorGraham Turner <turnertgraham@gmail.com>2018-09-09 09:46:20 -0400
committerGraham Turner <turnertgraham@gmail.com>2018-09-09 09:46:20 -0400
commit86aa8f8c5631f77ed9a208e5107003c01512133e (patch)
tree3e2c426e0055340587ee0357c47bf8058da21541 /activejob
parentfc173b0a2452dcaa527fd21d264ba2296d4fa72a (diff)
downloadrails-86aa8f8c5631f77ed9a208e5107003c01512133e.tar.gz
rails-86aa8f8c5631f77ed9a208e5107003c01512133e.tar.bz2
rails-86aa8f8c5631f77ed9a208e5107003c01512133e.zip
clarifies documentation around the attempts arugment to retry_on
Diffstat (limited to 'activejob')
-rw-r--r--activejob/lib/active_job/exceptions.rb4
1 files changed, 3 insertions, 1 deletions
diff --git a/activejob/lib/active_job/exceptions.rb b/activejob/lib/active_job/exceptions.rb
index 9a14c33d80..d8384c81b6 100644
--- a/activejob/lib/active_job/exceptions.rb
+++ b/activejob/lib/active_job/exceptions.rb
@@ -9,6 +9,7 @@ module ActiveJob
module ClassMethods
# Catch the exception and reschedule job for re-execution after so many seconds, for a specific number of attempts.
+ # The number of attempts includes the total executions of a job, not just the retried executions.
# If the exception keeps getting raised beyond the specified number of attempts, the exception is allowed to
# bubble up to the underlying queuing system, which may have its own retry mechanism or place it in a
# holding queue for inspection.
@@ -21,7 +22,8 @@ module ActiveJob
# as a computing proc that the number of executions so far as an argument, or as a symbol reference of
# <tt>:exponentially_longer</tt>, which applies the wait algorithm of <tt>(executions ** 4) + 2</tt>
# (first wait 3s, then 18s, then 83s, etc)
- # * <tt>:attempts</tt> - Re-enqueues the job the specified number of times (default: 5 attempts)
+ # * <tt>:attempts</tt> - Re-enqueues the job the specified number of times (default: 5 attempts),
+ # attempts here refers to the total number of times the job is executed, not just retried executions
# * <tt>:queue</tt> - Re-enqueues the job on a different queue
# * <tt>:priority</tt> - Re-enqueues the job with a different priority
#