docs(react-query/reference): remove stale 'suspense' references left over from the v5 suspense split by sukvvon · Pull Request #11200 · TanStack/query

sukvvon · 2026-08-16T17:37:41Z

🎯 Changes

Removes suspense from the "except for" option lists in useSuspenseInfiniteQuery.md and useSuspenseQueries.md, and removes a stale sentence about suspense's default behavior from useQuery.md's throwOnError description.

suspense was already omitted from UseInfiniteQueryOptions and UseQueryOptions (OmitKeyof<..., 'suspense'> in packages/react-query/src/types.ts), and DefaultOptions['queries'] omits it too — so it can never reach a plain useQuery/useInfiniteQuery/useQueries call. Listing it as something useSuspenseInfiniteQuery/useSuspenseQueries additionally excludes, or describing it as a behavior throwOnError: false disables, describes an unreachable state. useSuspenseQuery.md (the correct reference) never listed suspense for the same reason.

All three changes are pure removals — no new prose added, since useQuery.md and hydration.md are reused by Vue via ref: and unreviewed prose there risks being wrong for Vue's suspense model.

✅ 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 React query documentation to reflect current suspense behavior.
- Clarified supported and restricted options for suspense-based infinite queries and query collections.
- Removed outdated references to disabling suspense error-boundary behavior.

…over from the v5 suspense split

coderabbitai · 2026-08-16T17:38:00Z

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: dbb3f841-6c62-4e42-a08e-90f6ffceb1c6

📥 Commits

Reviewing files that changed from the base of the PR and between 4446c3a and 5f88e1b.

📒 Files selected for processing (3)

docs/framework/react/reference/useQuery.md
docs/framework/react/reference/useSuspenseInfiniteQuery.md
docs/framework/react/reference/useSuspenseQueries.md

💤 Files with no reviewable changes (3)

docs/framework/react/reference/useSuspenseInfiniteQuery.md
docs/framework/react/reference/useSuspenseQueries.md
docs/framework/react/reference/useQuery.md

Included review availability: Your plan includes up to 10 reviews per rolling hour; 9 remain after this review.

📝 Walkthrough

Walkthrough

The React reference documentation removes outdated suspense option restrictions and an obsolete throwOnError: false description.

Changes

Suspense documentation alignment

Layer / File(s)	Summary
Update suspense hook references `docs/framework/react/reference/useQuery.md`, `docs/framework/react/reference/useSuspenseInfiniteQuery.md`, `docs/framework/react/reference/useSuspenseQueries.md`	The documentation removes outdated suspense restrictions and the `throwOnError: false` error-boundary behavior description.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 5f88e

This change only removes stale documentation references and does not alter published code or runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Possibly related PRs

TanStack/query#11144: Both changes concern useSuspenseInfiniteQuery suspense behavior.
TanStack/query#11156: Both changes update throwOnError documentation for suspense hooks.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description explains the documentation changes and motivation, and it completes all required checklist and release-impact sections.
Title check	✅ Passed	The title clearly and concisely identifies the removal of stale suspense references from React Query 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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/remove-stale-suspense-references

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

nx-cloud · 2026-08-16T17:38:03Z

View your CI Pipeline Execution ↗ for commit 5f88e1b

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	3m 18s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	<1s	View ↗

☁️ Nx Cloud last updated this comment at 2026-08-16 17:42:09 UTC

github-actions · 2026-08-16T17:38:40Z

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

pkg-pr-new · 2026-08-16T17:41:20Z

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@11200

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@11200

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11200

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@11200

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@11200

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@11200

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@11200

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@11200

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@11200

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@11200

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@11200

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@11200

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@11200

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@11200

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@11200

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@11200

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@11200

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@11200

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@11200

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@11200

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@11200

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@11200

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@11200

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@11200

commit: 5f88e1b

github-actions · 2026-08-16T17:41:34Z

size-limit report 📦

Path	Size
react full	12.15 KB (0%)
react minimal	9.1 KB (0%)

docs(react-query/reference): remove stale 'suspense' references left …

5f88e1b

…over from the v5 suspense split

sukvvon self-assigned this Aug 16, 2026

sukvvon merged commit 4ace03b into main Aug 16, 2026
9 checks passed

sukvvon deleted the docs/remove-stale-suspense-references branch August 16, 2026 17:44

Navigation Menu

Uh oh!

Uh oh!

docs(react-query/reference): remove stale 'suspense' references left over from the v5 suspense split - #11200

docs(react-query/reference): remove stale 'suspense' references left over from the v5 suspense split#11200
sukvvon merged 1 commit into
mainfrom
docs/remove-stale-suspense-references

sukvvon commented Aug 16, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 16, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Aug 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 16, 2026

Uh oh!

pkg-pr-new Bot commented Aug 16, 2026

Uh oh!

github-actions Bot commented Aug 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Uh oh!

Conversation

sukvvon commented Aug 16, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Aug 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 16, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Aug 16, 2026

Uh oh!

github-actions Bot commented Aug 16, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Aug 16, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 16, 2026 •

edited

Loading

nx-cloud Bot commented Aug 16, 2026 •

edited

Loading