Skip to content

Commit 4f352c7

Browse files
authored
Fix typos
1 parent 254cdb6 commit 4f352c7

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/flow-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ The init arity is called once by the process to takes a set of args from the flo
3232

3333
### transition: `(step-fn state transition) -> state'`
3434

35-
The transition arity is called any time the flow or process undergoes a lifecycle transition (::flow/start, ::flow/stop, ::flow/pause, ::flow/resume). The description arity takes the current state and returns an updated state to be used for subsequent calls.
35+
The transition arity is called any time the flow or process undergoes a lifecycle transition (::flow/start, ::flow/stop, ::flow/pause, ::flow/resume). The transition arity takes the current state and returns an updated state to be used for subsequent calls.
3636

3737
The step-fn should use the transition arity to coordinate the creation, pausing, and shutdown of external resources in a process.
3838

3939
### transform: `(step-fn state input msg) -> [state' {out-id [msgs]}]`
4040

4141
The transform arity is called in a loop by the process for every message received on an input channel and returns a new state and a map of output cids to messages to return. The process will take care of sending these messages to the output channels. Output can be sent to none, any or all of the :outsenumerated, and/or an input named by a [pid inid] tuple (e.g. for reply-to), and/or to the ::flow/report output. A step need not output at all (output or msgs can be empyt/nil), however an output _message_ may never be nil (per core.async channels).
4242

43-
The step-fn may throw excepitons from any arity and they will be handled by flow. Exceptions thrown from the transition or transform arities, the exception will be logged on the flow's :error-chan.
43+
The step-fn may throw exceptions from any arity and they will be handled by flow. If exceptions are thrown from the transition or transform arities, the exception will be logged on the flow's :error-chan.
4444

4545
### Process state
4646

@@ -67,7 +67,7 @@ Process launchers can be created using the [process](https://clojure.github.io/c
6767
* `::workload` - one of `:mixed`, `:io` or `:compute`
6868
* `:compute-timeout-ms` - if :workload is :compute, this timeout (default 5000 msec) will be used when getting the return from the future - see below
6969

70-
A :workload supplied as an option to `process` will override any :workload returned by the :describe fn of the process launcher. If neither are provded the default is :mixed.
70+
A :workload supplied as an option to `process` will override any :workload returned by the :describe fn of the process launcher. If neither are provided the default is :mixed.
7171

7272
In the :workload context of :mixed or :io, this dictates the type of thread in which the process loop will run, _including its calls to transform_.
7373

@@ -131,4 +131,4 @@ The map returned from `start` has the flow's report and error channels. Procs ca
131131

132132
## Flow monitor
133133

134-
See [core.async.flow-monitor](https://github.com/clojure/core.async.flow-monitor/) for how to use the flow-monitor tool.
134+
See [core.async.flow-monitor](https://github.com/clojure/core.async.flow-monitor/) for how to use the flow-monitor tool.

0 commit comments

Comments
 (0)