From 86aa8f8c5631f77ed9a208e5107003c01512133e Mon Sep 17 00:00:00 2001 From: Graham Turner Date: Sun, 9 Sep 2018 09:46:20 -0400 Subject: [PATCH] clarifies documentation around the attempts arugment to retry_on --- activejob/lib/active_job/exceptions.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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 # :exponentially_longer, which applies the wait algorithm of (executions ** 4) + 2 # (first wait 3s, then 18s, then 83s, etc) - # * :attempts - Re-enqueues the job the specified number of times (default: 5 attempts) + # * :attempts - 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 # * :queue - Re-enqueues the job on a different queue # * :priority - Re-enqueues the job with a different priority #