Skip to content

Commit 0ff3cde

Browse files
Merge pull request #120 from dotflow-io/feature/119
πŸ“˜ DOCS-#119: Fix documentation gaps β€” incorrect references, missing parameters, outdated attributes
2 parents ee57b74 + 49f9ce3 commit 0ff3cde

10 files changed

Lines changed: 21 additions & 11 deletions

File tree

β€Ždocs/nav/reference/config.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
::: dotflow.core.config.Config
44
options:
55
members:
6-
- path
7-
- task_path
8-
- log_path
9-
- output
6+
- storage
7+
- notify
8+
- log
9+
- api

β€Ždocs/nav/reference/context.mdβ€Ž

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,3 @@
77
- task_id
88
- workflow_id
99
- storage
10-
- result_task
11-
- result_context
12-
- result_storage

β€Ždocs/nav/reference/dotflow.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@
99
- result_task
1010
- result_context
1111
- result_storage
12+
- result

β€Ždocs/nav/reference/task-builder.mdβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@
77
- count
88
- clear
99
- reverse
10+
- schema
11+
- result

β€Ždocs/nav/reference/task-instance.mdβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
- _initial_context
1212
- _current_context
1313
- _duration
14-
- _error
14+
- _errors
1515
- _status
1616
- _config
17-
- group_name
17+
- group_name
18+
- retry_count

β€Ždocs/nav/reference/workflow.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@
55
members:
66
- _callback_workflow
77
- sequential
8+
- sequential_group
89
- background
910
- parallel

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def my_task():
7272
7373
retry_delay (int): Retry delay on task on_failure. Duration (in seconds)
7474
75-
backoff (int): Exponential backoff
75+
backoff (bool): Exponential backoff. Doubles retry_delay after each attempt.
7676
7777
"""
7878

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class Config:
3737
Args:
3838
storage (Optional[Storage]): Type of the storage.
3939
notify (Optional[Notify]): Type of the notify.
40-
log (Optional[Log]): Type of the notify.
40+
log (Optional[Log]): Type of the log.
4141
4242
Attributes:
4343
storage (Optional[Storage]):

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ class DotFlow:
3030
Args:
3131
config (Optional[Config]): Configuration class.
3232
33+
workflow_id (Optional[str]): Fixed workflow identifier for checkpoint
34+
resume. If not provided, a random UUID is generated.
35+
3336
Attributes:
3437
workflow_id (UUID):
3538

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ class Manager:
7373
7474
workflow_id (UUID): Workflow ID.
7575
76+
resume (bool):
77+
If True, checks for existing checkpoints before executing each task.
78+
Tasks with a checkpoint are skipped and their saved context is used.
79+
Requires a persistent storage provider and a fixed workflow_id.
80+
7681
Attributes:
7782
on_success (Callable):
7883

0 commit comments

Comments
Β (0)