Skip to content

Comments

docs: add small nuance regarding the onCancel hook#3117

Closed
RobbyUitbeijerse wants to merge 2 commits intotriggerdotdev:mainfrom
RobbyUitbeijerse:main
Closed

docs: add small nuance regarding the onCancel hook#3117
RobbyUitbeijerse wants to merge 2 commits intotriggerdotdev:mainfrom
RobbyUitbeijerse:main

Conversation

@RobbyUitbeijerse
Copy link

@RobbyUitbeijerse RobbyUitbeijerse commented Feb 23, 2026

Thanks @isshaddad for the explanation on this one, I figured it could save some future questions to have this explicitly stated somewhere.

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the code works

@changeset-bot
Copy link

changeset-bot bot commented Feb 23, 2026

⚠️ No Changeset found

Latest commit: 32df65e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@RobbyUitbeijerse RobbyUitbeijerse changed the title Docs: add small nuance regarding the onCancel hook docs: add small nuance regarding the onCancel hook Feb 23, 2026
@github-actions
Copy link
Contributor

Hi @RobbyUitbeijerse, thanks for your interest in contributing!

This project requires that pull request authors are vouched, and you are not in the list of vouched users.

This PR will be closed automatically. See https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md for more details.

@github-actions github-actions bot closed this Feb 23, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 23, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6409fea and 32df65e.

📒 Files selected for processing (1)
  • docs/tasks/overview.mdx

Walkthrough

A documentation update to docs/tasks/overview.mdx that adds an informational note clarifying the behavior of the onCancel hook. The addition specifies that onCancel does not fire if the task being canceled is not currently executing, such as when the task has not started or is waiting at a waitpoint. This is a purely informational clarification with no changes to code logic or control flow.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 potential issue.

View 1 additional finding in Devin Review.

Open in Devin Review

```

<Info>
The `onCancel` hook doesn’t fire if the task being canceled isn’t currently executing (for example, it won’t run for tasks hat haven't started or tasks waiting at a waitpoint).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Typo: "tasks hat haven't started" should be "tasks that haven't started"

The newly added <Info> block contains a typo on line 534: "tasks hat haven't started" is missing the letter "t" in "that".

Details

The text reads:

it won't run for tasks hat haven't started

It should read:

it won't run for tasks that haven't started

Impact: Minor documentation typo visible to all users reading the docs.

Suggested change
The `onCancel` hook doesnt fire if the task being canceled isnt currently executing (for example, it wont run for tasks hat haven't started or tasks waiting at a waitpoint).
The `onCancel` hook doesn't fire if the task being canceled isn't currently executing (for example, it won't run for tasks that haven't started or tasks waiting at a waitpoint).
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

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.

1 participant