Skip to content

Commit a11a024

Browse files
πŸ“˜ DOCS-#205: Update Action docstring to reflect TaskEngine as executor
1 parent d5aa306 commit a11a024

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

β€Ždotflow/core/action.pyβ€Ž

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ def is_execution_with_class_internal_error(error: Exception) -> bool:
1919

2020

2121
class Action:
22-
"""
22+
"""Decorator for creating task steps.
23+
24+
Accepts configuration for retry, timeout, retry_delay, and backoff,
25+
which are stored as attributes and consumed by TaskEngine during execution.
26+
2327
Import:
2428
You can import the **action** decorator directly from dotflow:
2529
@@ -40,7 +44,6 @@ def my_task():
4044
def my_task():
4145
print("task")
4246
43-
4447
With Timeout
4548
4649
@action(timeout=60)
@@ -59,6 +62,10 @@ def my_task():
5962
def my_task():
6063
print("task")
6164
65+
Note:
66+
Retry, timeout, and backoff are enforced by TaskEngine.execute_with_retry(),
67+
not by Action itself. Action stores the configuration as attributes.
68+
6269
Args:
6370
func (Callable):
6471

0 commit comments

Comments
Β (0)