Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document throw(:abort) #506

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Document throw(:abort) #506

merged 1 commit into from
Sep 24, 2024

Conversation

Mangara
Copy link
Contributor

@Mangara Mangara commented Sep 24, 2024

Resolves #491

Job-iteration supports throw(:abort) for stopping a job mid-iteration, but this was undocumented. This PR adds some documentation for this feature.

Questions for reviewers

  • Is this the best place to put this documentation?
  • Should I add anything else here?
  • Spelling / grammar

@Mangara Mangara self-assigned this Sep 24, 2024
@Mangara Mangara merged commit 43a2559 into main Sep 24, 2024
45 checks passed
@Mangara Mangara deleted the mangara-docs-abort-job branch September 24, 2024 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How to return early or finish a job without further iterations and retries?
3 participants