From 3ab20e98454cd3c9f39c0b30f2bebb85e86d573e Mon Sep 17 00:00:00 2001 From: Brandur Date: Sat, 27 Apr 2024 21:07:51 -0700 Subject: [PATCH] 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`. --- lib/insert_opts.rb | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/insert_opts.rb b/lib/insert_opts.rb index 6840306..abd8dd3 100644 --- a/lib/insert_opts.rb +++ b/lib/insert_opts.rb @@ -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