Skip to content

Commit 0c7f173

Browse files
authored
Merge pull request rails#55184 from p8/activejob/fix-continuations-docs
Fix ActiveJob::Continuation documentation [ci skip]
2 parents 6c1120a + 946b38e commit 0c7f173

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

activejob/lib/active_job/continuable.rb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33
module ActiveJob
44
# = Active Job Continuable
55
#
6+
# The Continuable module provides the ability to track the progress of your
7+
# jobs, and continue from where they left off if interrupted.
8+
#
69
# Mix ActiveJob::Continuable into your job to enable continuations.
710
#
8-
# See +ActiveJob::Continuation+ for usage. # The Continuable module provides the ability to track the progress of your jobs,
9-
# and continue from where they left off if interrupted.
11+
# See {ActiveJob::Continuation}[rdoc-ref:ActiveJob::Continuation] for usage.
1012
#
1113
module Continuable
1214
extend ActiveSupport::Concern

activejob/lib/active_job/continuation.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,11 +161,11 @@ module ActiveJob
161161
# === Configuration
162162
#
163163
# Continuable jobs have several configuration options:
164-
# * :max_resumptions</tt> - The maximum number of times a job can be resumed. Defaults to +nil+ which means
164+
# * <tt>:max_resumptions</tt> - The maximum number of times a job can be resumed. Defaults to +nil+ which means
165165
# unlimited resumptions.
166166
# * <tt>:resume_options</tt> - Options to pass to +retry_job+ when resuming the job.
167-
# Defaults to +{ wait: 5.seconds }+.
168-
# See +ActiveJob::Exceptions#retry_job+ for available options.
167+
# Defaults to <tt>{ wait: 5.seconds }</tt>.
168+
# See {ActiveJob::Exceptions#retry_job}[rdoc-ref:ActiveJob::Exceptions#retry_job] for available options.
169169
# * <tt>:resume_errors_after_advancing</tt> - Whether to resume errors after advancing the continuation.
170170
# Defaults to +true+.
171171
class Continuation

0 commit comments

Comments
 (0)