-
-
Notifications
You must be signed in to change notification settings - Fork 725
fix(docs): Correct typo in '/idempotency' documentation #1456
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
fix(docs): Correct typo in '/idempotency' documentation #1456
Conversation
- Corrected 'idempotenceKeys' to 'idempotencyKeys' in code blocks 3 and 5.
|
WalkthroughThe pull request updates the documentation on idempotency, specifically clarifying the use of the Changes
Assessment against linked issues
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/idempotency.mdx (1)
There is one remaining instance of "idempotenceKeys" that needs to be corrected
Found one remaining instance of the incorrect spelling in:
packages/core/src/v3/types/tasks.ts
:const idempotencyKey = await idempotenceKeys.create(["my-task-trigger", "user-123"]);
🔗 Analysis chain
Line range hint
63-86
: Verify all instances of the typo have been fixedLet's verify that all instances of "idempotenceKeys" have been corrected throughout the codebase.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any remaining instances of the incorrect spelling echo "Checking for remaining instances of 'idempotenceKeys'..." rg "idempotenceKeys" # Search for the correct spelling to ensure consistency echo "Verifying usage of correct spelling 'idempotencyKeys'..." rg "idempotencyKeys"Length of output: 5212
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/idempotency.mdx
(2 hunks)
🔇 Additional comments (2)
docs/idempotency.mdx (2)
63-63
: LGTM! Correct spelling of idempotencyKeys
The spelling has been properly updated to use the correct term "idempotencyKeys".
86-86
: LGTM! Correct spelling of idempotencyKeys
The spelling has been properly updated to use the correct term "idempotencyKeys" in the batch trigger example.
Great, thanks! |
Description:
Closes #
✅ Checklist
Testing
I navigated to the
/idempotency
documentation file, located code blocks 3 and 5, and replaced "idempotenceKeys" with "idempotencyKeys". I reviewed the changes to ensure accuracy and consistency.Changelog
Corrected typos in the
idempotency
documentation.Screenshots
Not applicable as this change does not affect the UI.
Closes #1421
💯
Summary by CodeRabbit
idempotencyKey
.