cloudflare / cloudflare/cloudflare-docs

WorkflowStepConfig limit is the maximum number of retries, not attempts

Open
#30,627 2 comments 0 reactions 4 assignees Claimed by @mia303 View on GitHub
content:edit documentation product:workflows stale
Dominant language
MDX
Stars
5.2k
Forks
16.7k
Avg merge
2d 6h
Merged PRs (30d)
337

Description

### Existing documentation URL(s)

https://developers.cloudflare.com/workflows/build/sleeping-and-retrying/#retry-steps

### What changes are you suggesting?

The second **Retry steps** code sample is described as:
> to limit a step to 10 retries

but the code sample is:
```
retries: {
limit: 10, // The total number of attempts
```

These are contradictory: 10 retries means a total of 11 attempts. (Testing confirms that `retries.limit` is the maximum number of retries, not the maximum number of attempts.)

The code comment should be changed to:
```
retries: {
limit: 10, // The total number of retries (11 attempts total)
```

### Additional information

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.