@GitHK review

Author: sanderegg

packages/service-library/src/servicelib/background_task_utils.py

@@ -22,7 +22,7 @@ def exclusive_periodic(
 
     Arguments:
         client -- The Redis client
-        task_interval -- the task periodicity
+        task_interval -- the task interval, i.e. how often the task should run
         retry_after -- in case the exclusive lock cannot be acquired or is lost, this is the retry interval
 
     Raises:

packages/service-library/src/servicelib/redis/_decorators.py

@@ -45,18 +45,19 @@ def exclusive(
     [Callable[P, Coroutine[Any, Any, R]]], Callable[P, Coroutine[Any, Any, R]]
 ]:
     """
-        Define a method to run exclusively across
-        processes by leveraging a Redis Lock.
-    a1f69fdefa14fae2fee03fac7e89f27e44b13aa9
-        parameters:
-        redis: the redis client SDK
-        lock_key: a string as the name of the lock (good practice: app_name:lock_name)
-        lock_value: some additional data that can be retrieved by another client
-
-        Raises:
-            - ValueError if used incorrectly
-            - CouldNotAcquireLockError if the lock could not be acquired
-            - LockLostError if the lock was lost (e.g. due to Redis restart, or TTL was not extended in time)
+    Define a method to run exclusively across
+    processes by leveraging a Redis Lock.
+
+    Arguments:
+        redis -- the redis client
+        lock_key -- a string as the name of the lock (good practice: app_name:lock_name)
+        lock_value -- some additional data that can be retrieved by another client if None,
+                    it will be automatically filled with the current time and the client name
+
+    Raises:
+        - ValueError if used incorrectly
+        - CouldNotAcquireLockError if the lock could not be acquired
+        - LockLostError if the lock was lost (e.g. due to Redis restart, or TTL was not extended in time)
     """
 
     if not lock_key: