Skip to content

Commit 60ec4cb

Browse files
committed
fix(doc): iron out a few wrinkles
1 parent 242d91f commit 60ec4cb

File tree

4 files changed

+6
-2
lines changed

4 files changed

+6
-2
lines changed

lib/sidekiq_unique_jobs/lock/base_lock.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ def prepare_item
109109
#
110110
# Call whatever strategry that has been configured
111111
#
112-
# @param [Symbol] origin: the origin `:client` or `:server`
112+
# @param [Symbol] origin the origin `:client` or `:server`
113113
#
114114
# @return [void] the return value is irrelevant
115115
#

lib/sidekiq_unique_jobs/lock/while_executing.rb

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ class Lock
1111
#
1212
# @author Mikael Henriksson <[email protected]>
1313
class WhileExecuting < BaseLock
14+
#
15+
# @return [String] returns :RUN
1416
RUN_SUFFIX = ":RUN"
1517

1618
include SidekiqUniqueJobs::OptionsWithFallback

lib/sidekiq_unique_jobs/locksmith.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ def ==(other)
188188
#
189189
# @param [Sidekiq::RedisConnection, ConnectionPool] conn the redis connection
190190
# @param [Method] primed_method reference to the method to use for getting a primed token
191-
# @param [nil, Integer, Float] time to wait before timeout
191+
# @param [nil, Integer, Float] wait time to wait before timeout
192192
#
193193
# @yieldparam [string] job_id the sidekiq JID
194194
# @yieldreturn [void] whatever the calling block returns

lib/sidekiq_unique_jobs/server.rb

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ module SidekiqUniqueJobs
55
#
66
# @author Mikael Henriksson <[email protected]>
77
class Server
8+
#
9+
# @return [Proc] returns a default death handler for the gem to cleanup dead locks
810
DEATH_HANDLER = (lambda do |job, _ex|
911
return unless (digest = job["lock_digest"])
1012

0 commit comments

Comments
 (0)