fix(docs): Correct typo in '/idempotency' documentation

[Chisquare7]

Description:

• Corrected 'idempotenceKeys' to 'idempotencyKeys' in code blocks 3 and 5.

Closes #

✅ Checklist

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

---

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

• Documentation
  • Updated the idempotency document for clarity on the usage of idempotencyKey.
  • Expanded explanations and corrected typographical errors in code examples.
  • Enhanced examples to demonstrate flexibility in key generation.
  • Improved overall structure for better understanding of idempotency in task execution.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 58a525c

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]

Walkthrough

The pull request updates the documentation on idempotency, specifically clarifying the use of the idempotencyKey. It corrects typographical errors in function names, enhances explanations, and expands code examples to illustrate the creation of idempotency keys. The document structure has been improved for clarity, while retaining existing information about payload-based idempotency and the automatic injection of run IDs. Overall, the changes aim to ensure consistency and better understanding of idempotency in task execution.

Changes

File	Change Summary
docs/idempotency.mdx	Updated explanations and examples for idempotencyKey, corrected function name, improved clarity.

Assessment against linked issues

Objective	Addressed	Explanation
Correct idempotenceKeys to idempotencyKeys (1421)	✅
Fix typographical errors in code blocks	✅

Possibly related PRs

• Update self-hosting docs #1354: Documentation updates that may share similarities but do not directly relate to the idempotencyKey changes.

Poem

🐇 In the garden of code, a key does bloom,
Idempotency shines, dispelling the gloom.
With strings and arrays, it dances with grace,
Ensuring each task finds its rightful place.
A typo corrected, clarity's the aim,
In the world of documentation, we play the game! 🌼

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

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 fixed

Let'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

📥 Commits

Reviewing files that changed from the base of the PR and between c9811be and 58a525c.

📒 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.

[matt-aitken]

Great, thanks!