Skip to content

Commit 429764b

Browse files
committed
Documentation rewording
Signed-off-by: Greg Haskins <[email protected]>
1 parent 0fd0829 commit 429764b

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

doc/activities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ An Activity implementation consists of defining a (defactivity) function. This f
2424

2525
By default, Activities are automatically registered simply by declaring a (defactivity). You may optionally manually declare specific Activities to register when creating Workers (see [worker-options](https://cljdoc.org/d/io.github.manetu/temporal-sdk/CURRENT/api/temporal.client.worker#worker-options)).
2626

27-
*It should be noted that the name of the Activity is part of a contract, along with the arguments that the Activity accepts. Therefore, the Activity definition must be treated with care whenever code is refactored.*
27+
*It should be noted that the name of the Activity, the arguments that the Activity accepts, and the data that the Activity returns are all part of a contract that you need to maintain across potentially long-lived instances. Therefore, the Activity definition must be treated with care whenever code is refactored.*
2828

2929
## Starting Activity Executions
3030

doc/workflows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ There are some things however to think about when writing your Workflows, namely
5151

5252
By default, Workflows are automatically registered simply by declaring a (defworkflow). You may optionally manually declare specific Workflows to register when creating Workers (see [worker-options](https://cljdoc.org/d/io.github.manetu/temporal-sdk/CURRENT/api/temporal.client.worker#worker-options)).
5353

54-
*It should be noted that the name of the workflow is part of a contract, along with the arguments that the workflow accepts. Therefore, the Workflow definition must be treated with care whenever code is refactored.*
54+
*It should be noted that the name of the workflow, the arguments and signals that the workflow accepts, and the data that the workflow returns are all part of a contract that you need to maintain across potentially long-lived instances. Therefore, the Workflow definition must be treated with care whenever code is refactored.*
5555

5656
## Starting Workflow Executions
5757

@@ -147,7 +147,7 @@ Thus ensuring that the origination rules are met regardless of the outcome of th
147147

148148
### Await
149149

150-
You may use [await](https://cljdoc.org/d/io.github.manetu/temporal-sdk/CURRENT/api/temporal.core#await) to efficiently parks the Workflow until a provided predicate evaluates to true. The predicate is evaluated at each major state transition of the Workflow.
150+
You may use [await](https://cljdoc.org/d/io.github.manetu/temporal-sdk/CURRENT/api/temporal.core#await) to efficiently park the Workflow until a provided predicate evaluates to true. The predicate is evaluated at each major state transition of the Workflow.
151151

152152
### Temporal Signals
153153

0 commit comments

Comments
 (0)