fix(doc): iron out a few wrinkles

mhenrixon · Feb 12, 2024 · 60ec4cb · 60ec4cb
1 parent 242d91f
commit 60ec4cb
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git 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
@@ -11,6 +11,8 @@ class Lock
     #
     # @author Mikael Henriksson <mikael@mhenrixon.com>
     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
@@ -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
@@ -5,6 +5,8 @@ module SidekiqUniqueJobs
   #
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   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"])