Skip to content

Commit 9b6f4b4

Browse files
committed
Add design goal to documentation
1 parent c42cf5c commit 9b6f4b4

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/src/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ Typed Python interface to AWS Simple Workflow service
1212
on-demand)
1313
* Better execution filtering
1414

15+
The most interesting part is state construction: given an execution history, this
16+
library can build a full state of the execution and all of its tasks with all details;
17+
see :meth:`swf_typed.build_state`). The rest of the API simply wraps and closely
18+
matches AWS's SWF API.
19+
1520

1621
See also
1722
^^^^^^^^

0 commit comments

Comments
 (0)