Skip to content

Commit

Permalink
Add doc string for InsertOpts
Browse files Browse the repository at this point in the history
Add doc string for `InsertOpts`, which was previously missing, and
remove a Go-ism in the docblock on `#max_attempts`.
  • Loading branch information
brandur committed Apr 28, 2024
1 parent eefc884 commit 3ab20e9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions lib/insert_opts.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
module River
# Options for job insertion, and which can be provided by implementing
# #insert_opts on job args, or specified as a parameter on #insert or
# #insert_many.
class InsertOpts
# MaxAttempts is the maximum number of total attempts (including both the
# original run and all retries) before a job is abandoned and set as
# discarded.
# The maximum number of total attempts (including both the original run and
# all retries) before a job is abandoned and set as discarded.
attr_accessor :max_attempts

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

0 comments on commit 3ab20e9

Please sign in to comment.