Skip to content

Commit 4bd97e8

Browse files
docstrings for all the things (#63)
1 parent 2cf5b0f commit 4bd97e8

File tree

17 files changed

+880
-221
lines changed

17 files changed

+880
-221
lines changed
Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
1-
::: workflows.context
1+
::: workflows.context.Context
22
options:
3+
show_root_heading: true
4+
show_root_full_path: false
35
members:
4-
- Context
5-
filters: ["!^_", "^__init__$", "^collect_events$"]
6+
- __init__
7+
- collect_events
8+
- from_dict
9+
- get_result
10+
- is_running
11+
- send_event
12+
- store
13+
- to_dict
14+
- wait_for_event
15+
- write_event_to_stream
16+
17+
18+
::: workflows.context.state_store
19+
options:
20+
members:
21+
- DictState
22+
- InMemoryStateStore
23+
24+
::: workflows.context.serializers
25+
options:
26+
members:
27+
- BaseSerializer
28+
- JsonSerializer
29+
- PickleSerializer
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: workflows.errors

docs/docs/api_reference/workflow/events.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
options:
33
members:
44
- Event
5+
- InputRequiredEvent
6+
- HumanResponseEvent
57
- StartEvent
68
- StopEvent
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: workflows.handler
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: workflows.resource.Resource

docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ nav:
2222
- module_guides/workflow
2323
- Understanding:
2424
- Workflows:
25-
- understanding/workflow
25+
- understanding/workflows
2626
plugins:
2727
- search
2828
- include_dir_to_nav

0 commit comments

Comments
 (0)