Skip to content

docs: usage function examples were missing the imports#2830

Merged
nicktrn merged 2 commits intomainfrom
claude/slack-remove-v-imports-cm6Vn
Feb 4, 2026
Merged

docs: usage function examples were missing the imports#2830
nicktrn merged 2 commits intomainfrom
claude/slack-remove-v-imports-cm6Vn

Conversation

@matt-aitken
Copy link
Member

Closes #2828

claude added 2 commits January 5, 2026 10:11
Add the missing import statements for the usage object from
@trigger.dev/sdk/v3 to the code examples in the run-usage docs.
Update the import paths to use @trigger.dev/sdk instead of
@trigger.dev/sdk/v3 for consistency with other docs examples.
@changeset-bot
Copy link

changeset-bot bot commented Jan 5, 2026

⚠️ No Changeset found

Latest commit: 68c6226

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 5, 2026

Walkthrough

This change updates a documentation file (docs/run-usage.mdx) by adding missing import statements to code examples. The first example adds imports for task, usage, and wait from @trigger.dev/sdk, while a second example adds imports for usage and logger from the same package. These are documentation-only modifications to ensure code examples are complete and functional. No changes to runtime behavior, logic, or actual implementation code are included.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is minimal, containing only 'Closes #2828' without following the provided template structure including Testing, Changelog, and Screenshots sections. Fill out the complete PR description template with Testing section describing how changes were verified, Changelog section summarizing what changed, and other applicable sections.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR directly addresses issue #2828 by adding missing import statements for the usage object in run-usage documentation examples, resolving the core concern about undeclared usage references.
Out of Scope Changes check ✅ Passed The changes are limited to documentation file (docs/run-usage.mdx) with only import statement additions, staying within the scope of fixing the identified documentation issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately summarizes the main change: adding missing import statements to documentation examples for the usage function.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch claude/slack-remove-v-imports-cm6Vn

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

  • 136.113.208.247/32 (new)
  • 34.170.211.100/32
  • 35.222.179.152/32

Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist.


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.

@vibe-kanban-cloud
Copy link

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

@nicktrn nicktrn changed the title Docs: usage function examples were missing the imports docs: usage function examples were missing the imports Feb 4, 2026
@nicktrn nicktrn merged commit 7781e2a into main Feb 4, 2026
8 checks passed
@nicktrn nicktrn deleted the claude/slack-remove-v-imports-cm6Vn branch February 4, 2026 14:06
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.

Issue on docs run usage page

3 participants