Skip to content

Conversation

@Varunchandrashekar05
Copy link

@Varunchandrashekar05 Varunchandrashekar05 commented Oct 26, 2025

🎯 Changes

✅ 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
    • Updated guidance on skipToken behavior to clarify that calling refetch() with skipToken results in a Missing queryFn error. Added recommendation to use enabled: false instead when manual refetch functionality is required.

@changeset-bot
Copy link

changeset-bot bot commented Oct 26, 2025

⚠️ No Changeset found

Latest commit: c26f2df

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 Oct 26, 2025

Walkthrough

Documentation was updated in the disabling-queries guide to clarify the behavior of skipToken with refetch(). The guidance now explicitly states that calling refetch() on a query using skipToken results in a Missing queryFn error, and recommends using enabled: false to preserve refetch functionality.

Changes

Cohort / File(s) Summary
Documentation updates
docs/framework/react/guides/disabling-queries.md
Updated guidance on skipToken and refetch behavior to specify that refetch() with skipToken throws a Missing queryFn error; recommends using enabled: false for manual triggering instead

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Documentation clarification only; no code changes or logic modifications required

Poem

🐰 A token that skips with grace,
Now clearly shows its place—
No fetch when query's gone,
Use enabled to press on!
Our docs now shine, bright as space.

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description uses the correct template structure with all required sections present (Changes, Checklist, and Release Impact). However, the critical "🎯 Changes" section is completely empty—containing only the template placeholder comment asking "What changes are made in this PR?" with no actual description of the changes or their motivation. While the author did mark the change as "docs/CI/dev-only" in the Release Impact section, the absence of content in the main Changes section leaves the description largely incomplete and insufficient for understanding the purpose and scope of the modifications. The author should fill in the "🎯 Changes" section with a clear description of what documentation text was updated and why. Specifically, they should explain that the change improves the guidance on skipToken behavior by clarifying that calling refetch() on a query using skipToken now results in a "Missing queryFn" error, and recommending the use of enabled: false for manual triggering instead. Additionally, the unchecked checklist items should be addressed or their status updated if applicable.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (1 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Docs/improve skiptoken refetch incompatibility warning" accurately reflects the main change in the changeset. The raw summary indicates that the documentation text was updated to improve guidance around skipToken and refetch behavior, specifically warning about a "Missing queryFn error" that now occurs when calling refetch() with skipToken. The title is concise, specific, and clearly communicates the primary purpose of the change without vague terminology or noise.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8abbb95 and c26f2df.

📒 Files selected for processing (1)
  • docs/framework/react/guides/disabling-queries.md (1 hunks)
🔇 Additional comments (1)
docs/framework/react/guides/disabling-queries.md (1)

100-100: Documentation improvement clarifies skipToken and refetch() incompatibility.

The updated warning now explicitly explains that calling refetch() on a query using skipToken results in a Missing queryFn error, provides the technical reason (absence of a valid query function), and recommends enabled: false as an actionable alternative for users who need refetch functionality. This is a clear and helpful improvement over the previous wording.


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.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 26, 2025
@Varunchandrashekar05 Varunchandrashekar05 force-pushed the docs/improve-skiptoken-refetch-incompatibility-warning branch from 6f8d9a6 to 8abbb95 Compare October 26, 2025 17:13
@Varunchandrashekar05 Varunchandrashekar05 force-pushed the docs/improve-skiptoken-refetch-incompatibility-warning branch from 8abbb95 to 38b4008 Compare October 26, 2025 17:16
- Add detailed explanation of Missing queryFn error when using refetch() with skipToken
- Provide clear guidance to use enabled: false instead for manual refetching
- Systematic fix affects all frameworks (Vue, Angular, Solid) via inheritance

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant