Skip to content

fix(query-core): remove typo in QueryOptions#retry JSDoc#10606

Open
MattIPv4 wants to merge 1 commit intoTanStack:mainfrom
MattIPv4:patch-1
Open

fix(query-core): remove typo in QueryOptions#retry JSDoc#10606
MattIPv4 wants to merge 1 commit intoTanStack:mainfrom
MattIPv4:patch-1

Conversation

@MattIPv4
Copy link
Copy Markdown

@MattIPv4 MattIPv4 commented Apr 28, 2026

🎯 Changes

Typo in the JSDoc for QueryOptions#retry.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Fixed erroneous text in documentation.

@MattIPv4 MattIPv4 changed the title fix: remove typo in QueryOptions#retry JSDoc fix(query-core): remove typo in QueryOptions#retry JSDoc Apr 28, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 28, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e7961ad3-6ada-456c-a42d-e4a2070f751c

📥 Commits

Reviewing files that changed from the base of the PR and between c5ab5a1 and 1d1d0fe.

📒 Files selected for processing (1)
  • packages/query-core/src/types.ts

📝 Walkthrough

Walkthrough

Fixed JSDoc comment in the QueryOptions retry option by removing erroneous appended text that incorrectly followed the "infinitely." description, restoring proper documentation clarity without affecting code logic.

Changes

Cohort / File(s) Summary
JSDoc Documentation Fix
packages/query-core/src/types.ts
Removed erroneous snippet (failureCount: num) from the QueryOptions retry option JSDoc comment that was incorrectly appended after "infinitely."

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A typo in the docs did play,
Creating confusion along the way,
But with a swift and careful sweep,
The comments now are clean and deep!
Clarity restored, the path is clear—
Fine documentation, no need to fear! 📝✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately describes the main change: removing a typo in the QueryOptions#retry JSDoc comment.
Description check ✅ Passed The description follows the required template structure with all main sections completed, though the 'Changes' section could be slightly more detailed about the specific typo.
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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant