Merge pull request #49394 from johanstenberg92/fix-method-documentation-for-attempts-retry-on [ci skip]

Adjust method documentation for `ActiveJob::Exceptions::ClassMethods#retry_on`
This commit is contained in:
Petrik de Heus 2023-09-28 07:28:35 +02:00 committed by GitHub
commit a7041d3138
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions

View File

@ -26,8 +26,8 @@ module ActiveJob
# as a computing proc that takes the number of executions so far as an argument, or as a symbol reference of
# <tt>:polynomially_longer</tt>, which applies the wait algorithm of <tt>((executions**4) + (Kernel.rand * (executions**4) * jitter)) + 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) or a symbol reference of <tt>:unlimited</tt>
# to retry the job until it succeeds
# * <tt>:attempts</tt> - Enqueues the job the specified number of times (default: 5 attempts) or a symbol reference of <tt>:unlimited</tt>
# to retry the job until it succeeds. The number of attempts includes the original job execution.
# * <tt>:queue</tt> - Re-enqueues the job on a different queue
# * <tt>:priority</tt> - Re-enqueues the job with a different priority
# * <tt>:jitter</tt> - A random delay of wait time used when calculating backoff. The default is 15% (0.15) which represents the upper bound of possible wait time (expressed as a percentage)