Skip to content

Commit 74ffdba

Browse files
committed
Fix workflow documentation
Signed-off-by: Greg Haskins <[email protected]>
1 parent e9297fe commit 74ffdba

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

src/temporal/workflow.clj

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,22 @@ Return info about the current workflow
1616
(defmacro defworkflow
1717
"
1818
Defines a new workflow, similar to defn, expecting a 2-arity parameter list and body. Should evaluate to something
19-
serializable, which will become available for [[temporal.client.workflow/get-result]].
19+
serializable, which will become available for [[temporal.client.core/get-result]].
2020
2121
Arguments:
2222
2323
- `ctx`: Context passed through from [[temporal.client.worker/start]]
24-
- `args`: Passed from 'params' to [[temporal.client.workflow/start]] or [[temporal.client.workflow/signal-with-start]]
24+
- `params`: A map containing the following
25+
- `args`: Passed from 'params' to [[temporal.client.core/start]] or [[temporal.client.core/signal-with-start]]
26+
- `signals`: Signal context for use with signal calls such as [[temporal.signals/<!]] and [[temporal.signals/poll]]
2527
2628
```clojure
2729
(defworkflow my-workflow
28-
[ctx args]
30+
[ctx {{:keys [foo]} :args}]
2931
...)
32+
33+
(let [w (create-workflow client my-workflow {:task-queue ::my-task-queue})]
34+
(start w {:foo \"bar\"}))
3035
```
3136
"
3237
[name params* & body]

0 commit comments

Comments
 (0)