Skip to content

Commit

Permalink
Docs (#2056)
Browse files Browse the repository at this point in the history
* Correct duplicate word.

* Correct indefinite article.
  • Loading branch information
max8github authored Mar 6, 2024
1 parent b1f0d03 commit 3c38b2c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/src/modules/java/pages/timers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ include::example$java-spring-reliable-timers/src/main/java/com/example/actions/O
<2> If the `CompletionStage` completes successfully, it's all good and can simply return `Ok`. Since this method is returning normally, the timer will be considered as executed and will be removed from Kalix.
<3> On the other hand, if the `CompletionStage` completes with a failure, you must decide if you will recover the call or not. If you recover it, the timer will be considered as completed. If you let the call fail, the timer will be re-scheduled.

You have seen the `OrderEntity.cancel` implementation, so you know that if you get a `NOT_FOUND`, it means that either the Order never existed or it was already cancelled (deleted). Or, you may get an `BAD_REQUEST` error, meaning that the order has been confirmed in the meantime. In both cases, you can consider that the timer has become obsolete and don't need to be rescheduled, therefore we recover the call.
You have seen the `OrderEntity.cancel` implementation, so you know that if you get a `NOT_FOUND`, it means that either the Order never existed or it was already cancelled (deleted). Or, you may get a `BAD_REQUEST` error, meaning that the order has been confirmed in the meantime. In both cases, you can consider that the timer has become obsolete and don't need to be rescheduled, therefore we recover the call.

For all other possible errors, the call to `OrderAction.expire` will fail and the timer will be re-scheduled.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/java/pages/workflows.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Design for failure is one of the key attributes of all Kalix components. Workflo

=== Timeouts

By default, a workflow run has no time limit. It can run forever, which in most cases is not desirable behavior. A workflow step, on the other hand, has a default timeout of 5 seconds timeout. Both settings can be overridden at the workflow definition level or for a specific step configuration.
By default, a workflow run has no time limit. It can run forever, which in most cases is not desirable behavior. A workflow step, on the other hand, has a default timeout of 5 seconds. Both settings can be overridden at the workflow definition level or for a specific step configuration.

[source,java,indent=0]
.src/main/java/com/example/transfer/TransferWorkflow.java
Expand Down

0 comments on commit 3c38b2c

Please sign in to comment.