doc: Add a code doc.

Doist · Oct 7, 2024 · bee935d · bee935d
1 parent 45dbc00
commit bee935d
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/sqs_workers/async_task.py b/sqs_workers/async_task.py
@@ -24,6 +24,14 @@
 
 
 class AsyncTaskDelayArgs(TypedDict):
+    """
+    Extra arguments accepted by `AsyncTask.delay`. This mapping can be used with `Unpack` to
+    improve typing of task function when `delay` is used.
+
+    `def task(..., **_delay_args: Unpack[AsyncTaskDelayArgs]) -> None: ...`
+    """
+
+    _content_type: NotRequired[str]
     _delay_seconds: NotRequired[float]
     _deduplication_id: NotRequired[str]
     _group_id: NotRequired[str]