Skip to content

Commit 9b303fb

Browse files
authored
Fix capitalization and typos in documentation
1 parent e83fc73 commit 9b303fb

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/how-it-works.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 10
44

55
# How It Works
66

7-
Workflow is a library that uses Laravel's queued jobs and event sourced persistence to create durable coroutines.
7+
Durable Workflow uses Laravel's queued jobs and event sourced persistence to create durable coroutines.
88

99
## Queues
1010

@@ -18,7 +18,7 @@ Event sourcing is a way to build up the current state from a sequence of saved e
1818

1919
Coroutines are functions that allow execution to be suspended and resumed by returning control to the calling function. In PHP, this is done using the yield keyword inside a generator. A generator is typically invoked by calling the [`Generator::current()`](https://www.php.net/manual/en/generator.current.php) method. This will execute the generator up to the first yield and then control will be returned to the caller.
2020

21-
In Workflow, the execute() method of a workflow class is a [generator](https://www.php.net/manual/en/language.generators.syntax.php). It works by yielding each activity. This allows the workflow to first check if the activity has already successfully completed. If so, the cached result is pulled from the event store and returned instead of running the activity a second time. If the activity hasn't been successfully completed before, it will queue the activity to run. The workflow is then able to suspend execution until the activity completes or fails.
21+
The `execute()` method of a workflow class is a [generator](https://www.php.net/manual/en/language.generators.syntax.php). It works by yielding each activity. This allows the workflow to first check if the activity has already successfully completed. If so, the cached result is pulled from the event store and returned instead of running the activity a second time. If the activity hasn't been successfully completed before, it will queue the activity to run. The workflow is then able to suspend execution until the activity completes or fails.
2222

2323
## Activities
2424

@@ -54,7 +54,7 @@ class MyWorkflow extends Workflow
5454

5555
## Sequence Diagram
5656

57-
This sequence diagram shows how a Workflow progresses through a series of activities, both serial and parallel.
57+
This sequence diagram shows how a workflow progresses through a series of activities, both serial and parallel.
5858

5959
import ThemedImage from '@site/src/components/ThemedImage';
6060

0 commit comments

Comments
 (0)