Skip to content

Commit 6419962

Browse files
Fix grammar errors in documentation (#320)
* Fix grammar errors in documentation Fixed grammar errors in the documentation as requested. ## Changes Made **Modified Files:** - `CLAUDE.md` - Fixed 3 grammar errors: - "propogate" → "propagate" - "changeset" → "changesets" (added missing plural) - "amke chagnesets" → "make changesets" - Added missing closing quote for "**BREAKING CHANGE**" - `docs/content/docs/foundations/index.mdx` - Fixed 2 grammar errors: - "real world" → "real-world" (hyphenated compound adjective) - "go a long way in using workflows" → "go a long way in helping you use workflows effectively" (improved clarity and grammar) - `docs/content/docs/foundations/workflows-and-steps.mdx` - Fixed 2 grammar errors: - "resume to workflow" → "resume the workflow" - "each time, using" → "each time using" (removed unnecessary comma) - "workflows are run in" → "workflows run in" (improved verb form) - `docs/content/docs/foundations/errors-and-retries.mdx` - Fixed 3 grammar errors: - Missing space: "RetryableError`](/docs...)and" → "RetryableError`](/docs...) and" - "we've learnt" → "we've learned" (consistent American English) - "Rolling back failed steps" → "Rolling Back Failed Steps" (proper title case) - `packages/workflow/README.md` - Fixed 1 grammar error: - "engineers are" → "engineers are:" (added missing colon before list) ## Summary Total of 11 grammar errors fixed across 5 documentation files. The fixes include: - Spelling corrections (propogate → propagate, learnt → learned) - Punctuation improvements (missing spaces, colons, quotes) - Grammatical improvements (verb forms, compound adjectives) - Style consistency (American English, title case) All changes maintain the original meaning and formatting while improving readability and professional presentation of the documentation. Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com> * Changeset --------- Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com> Co-authored-by: Peter Wielander <mittgfu@gmail.com>
1 parent 8e96134 commit 6419962

File tree

6 files changed

+16
-11
lines changed

6 files changed

+16
-11
lines changed

.changeset/pink-aliens-itch.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"workflow": patch
3+
---
4+
5+
Update readme

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,5 +160,5 @@ This project uses pnpm with workspace configuration. The required version is spe
160160
- All changed packages should be included in the changeset. Never include unchanged packages.
161161
- All changes should be marked as "patch". Never use "major" or "minor" modes.
162162
- Remember to always build any packages that get changed before running downstream tests like e2e tests in the workbench
163-
- Remember that changes made to one workbench should propogate to all other workbenches. The workflows should typically only be written once inside the example workbench and symlinked into all the other workbenches
164-
- When writing changeset, use the `pnpm changeset` command from the root of the repo. Keep the changesets terse (see existing changesets for examples). Try to amke chagnesets that are specific to each modified package so they are targeted. Ensure that any breaking changes are marked as "**BREAKING CHANGE**
163+
- Remember that changes made to one workbench should propagate to all other workbenches. The workflows should typically only be written once inside the example workbench and symlinked into all the other workbenches
164+
- When writing changesets, use the `pnpm changeset` command from the root of the repo. Keep the changesets terse (see existing changesets for examples). Try to make changesets that are specific to each modified package so they are targeted. Ensure that any breaking changes are marked as "**BREAKING CHANGE**"

docs/content/docs/foundations/errors-and-retries.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ async function callApi(endpoint: string) {
6565

6666
## Customize Retry Behavior
6767

68-
When you need to customize the delay on the retry, use [`RetryableError`](/docs/api-reference/workflow/retryable-error)and set the retryAfter property.
68+
When you need to customize the delay on the retry, use [`RetryableError`](/docs/api-reference/workflow/retryable-error) and set the retryAfter property.
6969

7070
```typescript lineNumbers
7171
import { FatalError, RetryableError } from "workflow";
@@ -95,7 +95,7 @@ async function callApi(endpoint: string) {
9595

9696
## Advanced Example
9797

98-
This final example combines everything we've learnt, along with [`getStepMetadata`](/docs/api-reference/workflow/get-step-metadata).
98+
This final example combines everything we've learned, along with [`getStepMetadata`](/docs/api-reference/workflow/get-step-metadata).
9999

100100
```typescript lineNumbers
101101
import { FatalError, RetryableError, getStepMetadata } from "workflow";
@@ -129,7 +129,7 @@ async function callApi(endpoint: string) {
129129
callApi.maxRetries = 5;
130130
```
131131

132-
## Rolling back failed steps
132+
## Rolling Back Failed Steps
133133

134134
When a workflow fails partway through, it can leave the system in an inconsistent state.
135135
A common pattern to address this is "rollbacks": for each successful step, record a corresponding rollback action that can undo it.

docs/content/docs/foundations/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ title: Foundations
44

55
# Foundations
66

7-
Workflow programming can be a slight shift from how you traditionally write real world applications. Learning the foundations
8-
now will go a long way in using workflows.
7+
Workflow programming can be a slight shift from how you traditionally write real-world applications. Learning the foundations
8+
now will go a long way in helping you use workflows effectively.
99

1010
<Cards>
1111
<Card href="/docs/foundations/workflows-and-steps" title="Workflows and Steps">

docs/content/docs/foundations/workflows-and-steps.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ export async function processOrderWorkflow(orderId: string) {
4343
- All step results are persisted to the event log
4444
- Must be **deterministic** to allow resuming after failures
4545

46-
Determinism in the workflow is required in order to resume to workflow from a suspension. Essentially, the workflow code gets re-run multiple times during its lifecycle,
47-
each time, using an event log to resume the workflow to the correct spot.
46+
Determinism in the workflow is required in order to resume the workflow from a suspension. Essentially, the workflow code gets re-run multiple times during its lifecycle,
47+
each time using an event log to resume the workflow to the correct spot.
4848

49-
The sandboxed environment that workflows are run in already ensures determinism. For instance, `Math.random` and `Date` constructors are fixed in workflow runs, so you are safe to use them and the framework ensures that the values don't change across replays.
49+
The sandboxed environment that workflows run in already ensures determinism. For instance, `Math.random` and `Date` constructors are fixed in workflow runs, so you are safe to use them and the framework ensures that the values don't change across replays.
5050

5151
## Step Functions
5252

packages/workflow/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Contributions to Workflow DevKit are welcome and highly appreciated. Please use
3232

3333
Workflow DevKit was built by engineers at [Vercel](https://vercel.com) and the [Open Source Community](https://github.com/vercel/workflow/graphs/contributors).
3434

35-
The initial core contributing engineers are
35+
The initial core contributing engineers are:
3636

3737
- Adrian Lam ([@adriandlam](https://github.com/adriandlam))
3838
- Dillon Mulroy ([@dmmulroy](https://github.com/dmmulroy))

0 commit comments

Comments
 (0)