From 60ec4cbedfa75dfc79cb76c6b84eacac5794fa8a Mon Sep 17 00:00:00 2001 From: mhenrixon Date: Mon, 12 Feb 2024 18:07:32 +0200 Subject: [PATCH] fix(doc): iron out a few wrinkles --- lib/sidekiq_unique_jobs/lock/base_lock.rb | 2 +- lib/sidekiq_unique_jobs/lock/while_executing.rb | 2 ++ lib/sidekiq_unique_jobs/locksmith.rb | 2 +- lib/sidekiq_unique_jobs/server.rb | 2 ++ 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/sidekiq_unique_jobs/lock/base_lock.rb b/lib/sidekiq_unique_jobs/lock/base_lock.rb index d0420a6fe..017db3091 100644 --- a/lib/sidekiq_unique_jobs/lock/base_lock.rb +++ b/lib/sidekiq_unique_jobs/lock/base_lock.rb @@ -109,7 +109,7 @@ def prepare_item # # Call whatever strategry that has been configured # - # @param [Symbol] origin: the origin `:client` or `:server` + # @param [Symbol] origin the origin `:client` or `:server` # # @return [void] the return value is irrelevant # diff --git a/lib/sidekiq_unique_jobs/lock/while_executing.rb b/lib/sidekiq_unique_jobs/lock/while_executing.rb index 0aecf9a32..320061197 100644 --- a/lib/sidekiq_unique_jobs/lock/while_executing.rb +++ b/lib/sidekiq_unique_jobs/lock/while_executing.rb @@ -11,6 +11,8 @@ class Lock # # @author Mikael Henriksson class WhileExecuting < BaseLock + # + # @return [String] returns :RUN RUN_SUFFIX = ":RUN" include SidekiqUniqueJobs::OptionsWithFallback diff --git a/lib/sidekiq_unique_jobs/locksmith.rb b/lib/sidekiq_unique_jobs/locksmith.rb index 3e475ac52..3f49619c3 100644 --- a/lib/sidekiq_unique_jobs/locksmith.rb +++ b/lib/sidekiq_unique_jobs/locksmith.rb @@ -188,7 +188,7 @@ def ==(other) # # @param [Sidekiq::RedisConnection, ConnectionPool] conn the redis connection # @param [Method] primed_method reference to the method to use for getting a primed token - # @param [nil, Integer, Float] time to wait before timeout + # @param [nil, Integer, Float] wait time to wait before timeout # # @yieldparam [string] job_id the sidekiq JID # @yieldreturn [void] whatever the calling block returns diff --git a/lib/sidekiq_unique_jobs/server.rb b/lib/sidekiq_unique_jobs/server.rb index 878af76d8..0505c2628 100644 --- a/lib/sidekiq_unique_jobs/server.rb +++ b/lib/sidekiq_unique_jobs/server.rb @@ -5,6 +5,8 @@ module SidekiqUniqueJobs # # @author Mikael Henriksson class Server + # + # @return [Proc] returns a default death handler for the gem to cleanup dead locks DEATH_HANDLER = (lambda do |job, _ex| return unless (digest = job["lock_digest"])