Skip to content

Commit

Permalink
fix(doc): iron out a few wrinkles
Browse files Browse the repository at this point in the history
  • Loading branch information
mhenrixon committed Feb 12, 2024
1 parent 242d91f commit 60ec4cb
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion lib/sidekiq_unique_jobs/lock/base_lock.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
#
Expand Down
2 changes: 2 additions & 0 deletions lib/sidekiq_unique_jobs/lock/while_executing.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ class Lock
#
# @author Mikael Henriksson <[email protected]>
class WhileExecuting < BaseLock
#
# @return [String] returns :RUN
RUN_SUFFIX = ":RUN"

include SidekiqUniqueJobs::OptionsWithFallback
Expand Down
2 changes: 1 addition & 1 deletion lib/sidekiq_unique_jobs/locksmith.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions lib/sidekiq_unique_jobs/server.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ module SidekiqUniqueJobs
#
# @author Mikael Henriksson <[email protected]>
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"])

Expand Down

0 comments on commit 60ec4cb

Please sign in to comment.