Skip to content

Commit 3ab20e9

Browse files
committed
Add doc string for InsertOpts
Add doc string for `InsertOpts`, which was previously missing, and remove a Go-ism in the docblock on `#max_attempts`.
1 parent eefc884 commit 3ab20e9

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

lib/insert_opts.rb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
module River
2+
# Options for job insertion, and which can be provided by implementing
3+
# #insert_opts on job args, or specified as a parameter on #insert or
4+
# #insert_many.
25
class InsertOpts
3-
# MaxAttempts is the maximum number of total attempts (including both the
4-
# original run and all retries) before a job is abandoned and set as
5-
# discarded.
6+
# The maximum number of total attempts (including both the original run and
7+
# all retries) before a job is abandoned and set as discarded.
68
attr_accessor :max_attempts
79

810
# The priority of the job, with 1 being the highest priority and 4 being the

0 commit comments

Comments
 (0)