summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2022-09-03 22:59:34 +0300
committerAlex Grönholm <alex.gronholm@nextday.fi>2022-09-03 22:59:34 +0300
commit90a9675f4444809c72c25a450a40243be8110b68 (patch)
treec87036596ae3054ed39b260163fcbdce0de8ca67
parentf41a7e5c5588f1c802645a6e18292dfb9ac3ba16 (diff)
downloadapscheduler-90a9675f4444809c72c25a450a40243be8110b68.tar.gz
Fixed docstring on stop_check_interval
-rw-r--r--src/apscheduler/eventbrokers/async_redis.py6
-rw-r--r--src/apscheduler/eventbrokers/redis.py5
2 files changed, 6 insertions, 5 deletions
diff --git a/src/apscheduler/eventbrokers/async_redis.py b/src/apscheduler/eventbrokers/async_redis.py
index 00d526f..c2a5711 100644
--- a/src/apscheduler/eventbrokers/async_redis.py
+++ b/src/apscheduler/eventbrokers/async_redis.py
@@ -32,9 +32,9 @@ class AsyncRedisEventBroker(LocalAsyncEventBroker, DistributedEventBrokerMixin):
:param channel: channel on which to send the messages
:param retry_settings: Tenacity settings for retrying operations in case of a
broker connectivity problem
- :param stop_check_interval: interval on which the channel listener should check if
- it
- values mean slower reaction time but less CPU use)
+ :param stop_check_interval: interval (in seconds) on which the channel listener
+ should check if it should stop (higher values mean slower reaction time but less
+ CPU use)
"""
client: Redis | RedisCluster
diff --git a/src/apscheduler/eventbrokers/redis.py b/src/apscheduler/eventbrokers/redis.py
index 8f6c2c3..6683276 100644
--- a/src/apscheduler/eventbrokers/redis.py
+++ b/src/apscheduler/eventbrokers/redis.py
@@ -27,8 +27,9 @@ class RedisEventBroker(LocalEventBroker, DistributedEventBrokerMixin):
:param client: a (synchronous) Redis client
:param serializer: the serializer used to (de)serialize events for transport
:param channel: channel on which to send the messages
- :param stop_check_interval: interval on which to poll for new messages (higher
- values mean slower reaction time but less CPU use)
+ :param stop_check_interval: interval (in seconds) on which the channel listener
+ should check if it should stop (higher values mean slower reaction time but less
+ CPU use)
"""
client: Redis | RedisCluster