Skip to content

Commit

Permalink
Fix :id documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
romdoq authored and hipitihop committed May 23, 2023
1 parent a9bc180 commit 93e97e9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,11 +355,11 @@ Further Notes:

The `:async-flow` data structure has the following fields:

- `:id` - optional - an identifier, typically a namespaced keyword. Each flow should have a unique id.
- `:id` - optional - an identifier, typically a unique namespaced keyword.
If not supplied, a unique value will be generated.
Must not clash with the identifier for any event handler (because internally
an event handler is registered using this id).
If absent, `:async/flow` is used.
If this default is used then two flows can't be running at once because they'd be using the same id.
If two flows have the same ID, they cannot be run at the same time.

- `db-path` - optional - the path within `app-db` where the coordination logic should store state. Two pieces
of state are stored: the set of seen events, and the set of started tasks.
Expand Down

0 comments on commit 93e97e9

Please sign in to comment.