From b57d63870774a47ee71cc19826ec81b494331197 Mon Sep 17 00:00:00 2001 From: Felix Wolfsteller Date: Fri, 25 Oct 2024 13:09:39 +0200 Subject: [PATCH] mention ttl and timeout unit (seconds) in README (#859) Update README.md - mention ttl and timeout unit (seconds) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 358a65bd..8fa7c60a 100644 --- a/README.md +++ b/README.md @@ -775,7 +775,7 @@ Turning on debug_lua will allow the lua scripts to output debug information abou SidekiqUniqueJobs.config.lock_timeout #=> 0 ``` -Set a global lock_timeout to use for all jobs that don't otherwise specify a lock_timeout. +Set a global lock_timeout (in seconds) to use for all jobs that don't otherwise specify a lock_timeout. Lock timeout decides how long to wait for acquiring the lock. A value of nil means to wait indefinitely for a lock resource to become available. @@ -785,7 +785,7 @@ Lock timeout decides how long to wait for acquiring the lock. A value of nil mea SidekiqUniqueJobs.config.lock_ttl #=> nil ``` -Set a global lock_ttl to use for all jobs that don't otherwise specify a lock_ttl. +Set a global lock_ttl (in seconds) to use for all jobs that don't otherwise specify a lock_ttl. Lock TTL decides how long to wait at most before considering a lock to be expired and making it possible to reuse that lock.