Skip to content

chore: fix typo "recieve" → "receive" in api.ts JSDoc#652

Closed
premsreelathasugeendran wants to merge 1 commit intoSnazzah:masterfrom
premsreelathasugeendran:fix/typo-recieve-receive
Closed

chore: fix typo "recieve" → "receive" in api.ts JSDoc#652
premsreelathasugeendran wants to merge 1 commit intoSnazzah:masterfrom
premsreelathasugeendran:fix/typo-recieve-receive

Conversation

@premsreelathasugeendran
Copy link
Copy Markdown

@premsreelathasugeendran premsreelathasugeendran commented May 10, 2026

JSDoc-only typo fix on @param withResponse description in src/api.ts. No behavior change.

Summary by CodeRabbit

  • Documentation
    • Corrected API documentation for improved accuracy and clarity.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ffb0bed7-1c46-45ae-bf4b-9e2d3b72f9fb

📥 Commits

Reviewing files that changed from the base of the PR and between 7c367a0 and ddca430.

📒 Files selected for processing (1)
  • src/api.ts

📝 Walkthrough

Walkthrough

The PR corrects a spelling error in the JSDoc documentation for the SlashCreatorAPI.interactionCallback method, changing "recieve" to "receive" in the withResponse parameter description. No functional code, method signatures, or behavior are altered.

Changes

Documentation Fix

Layer / File(s) Summary
JSDoc Correction
src/api.ts
The withResponse parameter description in interactionCallback method's JSDoc is corrected from "recieve" to "receive".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

A tiny typo, caught in flight,
"Recieve" now "receive"—spelled just right! 🐰✨
One letter fixed, one doc made clear,
The simplest change we'll see this year.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically describes the main change: fixing a typo in JSDoc documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@Snazzah Snazzah added the type: documentation Improvements or additions to documentation label May 11, 2026
@Snazzah Snazzah closed this May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants