Skip to content

Commit 2d7e587

Browse files
author
Andrei Neagu
committed
updated docstrings
1 parent 6552ddf commit 2d7e587

File tree

2 files changed

+14
-10
lines changed
  • packages/service-library/src/servicelib

2 files changed

+14
-10
lines changed

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_server.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,19 +155,21 @@ def setup(
155155
redis_settings: RedisSettings,
156156
rabbit_settings: RabbitSettings,
157157
lrt_namespace: LRTNamespace,
158-
handler_check_decorator: Callable = _no_ops_decorator,
159-
task_request_context_decorator: Callable = _no_task_context_decorator,
160158
stale_task_check_interval: datetime.timedelta = DEFAULT_STALE_TASK_CHECK_INTERVAL,
161159
stale_task_detect_timeout: datetime.timedelta = DEFAULT_STALE_TASK_DETECT_TIMEOUT,
160+
handler_check_decorator: Callable = _no_ops_decorator,
161+
task_request_context_decorator: Callable = _no_task_context_decorator,
162162
) -> None:
163163
"""
164164
- `router_prefix` APIs are mounted on `/...`, this
165165
will change them to be mounted as `{router_prefix}/...`
166-
- `stale_task_check_interval_s` interval at which the
166+
- `redis_settings` settings for Redis connection
167+
- `rabbit_settings` settings for RabbitMQ connection
168+
- `lrt_namespace` namespace for the long-running tasks
169+
- `stale_task_check_interval` interval at which the
167170
TaskManager checks for tasks which are no longer being
168171
actively monitored by a client
169-
- `stale_task_detect_timeout_s` interval after which a
170-
task is considered stale
172+
- `stale_task_detect_timeout` interval after which atask is considered stale
171173
"""
172174

173175
async def on_cleanup_ctx(app: web.Application) -> AsyncGenerator[None, None]:

packages/service-library/src/servicelib/fastapi/long_running_tasks/_server.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,15 @@ def setup(
2626
stale_task_detect_timeout: datetime.timedelta = DEFAULT_STALE_TASK_DETECT_TIMEOUT,
2727
) -> None:
2828
"""
29-
- `router_prefix` APIs are mounted on `/task/...`, this
30-
will change them to be mounted as `{router_prefix}/task/...`
31-
- `stale_task_check_interval_s` interval at which the
29+
- `router_prefix` APIs are mounted on `/...`, this
30+
will change them to be mounted as `{router_prefix}/...`
31+
- `redis_settings` settings for Redis connection
32+
- `rabbit_settings` settings for RabbitMQ connection
33+
- `lrt_namespace` namespace for the long-running tasks
34+
- `stale_task_check_interval` interval at which the
3235
TaskManager checks for tasks which are no longer being
3336
actively monitored by a client
34-
- `stale_task_detect_timeout_s` interval after which a
35-
task is considered stale
37+
- `stale_task_detect_timeout` interval after which atask is considered stale
3638
"""
3739

3840
async def on_startup() -> None:

0 commit comments

Comments
 (0)