Skip to content

docs(vue-query/reference): hide React-only 'React.use()' mention from useInfiniteQuery - #11203

Merged
sukvvon merged 1 commit into
mainfrom
docs/hide-react-use-from-vue-infinite-query
Aug 16, 2026
Merged

docs(vue-query/reference): hide React-only 'React.use()' mention from useInfiniteQuery#11203
sukvvon merged 1 commit into
mainfrom
docs/hide-react-use-from-vue-infinite-query

Conversation

@sukvvon

@sukvvon sukvvon commented Aug 16, 2026

Copy link
Copy Markdown
Member

🎯 Changes

Wraps the React.use() mention in useInfiniteQuery.md's promise return-value description in a [//]: # 'ReactUse' marker pair (same mechanism already used by hydration.md for the HydrationBoundary section, and by initial-query-data.md for its Example2/Example3/Example4 code blocks — including the indented-list-item form).

useInfiniteQuery.md is reused by Vue via ref:. React.use() is a React 19-only API with no Vue equivalent, and this line currently renders verbatim on the live Vue reference page (confirmed at tanstack.com/query/latest/docs/framework/vue/reference/useInfiniteQuery). Adding an empty marker pair of the same name to Vue's useInfiniteQuery.md strips the line from Vue's rendered page while leaving React's own page unchanged (the marker is a Markdown comment).

✅ 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
    • Added documentation markers to the React and Vue useInfiniteQuery reference pages.
    • Clarified integration guidance for handling promise results in React without changing the existing guidance.

@coderabbitai

coderabbitai Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 4b527c7b-c41d-43aa-8501-ff43fb931a62

📥 Commits

Reviewing files that changed from the base of the PR and between 0785da5 and d8fce1e.

📒 Files selected for processing (2)
  • docs/framework/react/reference/useInfiniteQuery.md
  • docs/framework/vue/reference/useInfiniteQuery.md

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


📝 Walkthrough

Walkthrough

Added ReactUse documentation markers to the React and Vue useInfiniteQuery reference pages. The existing React.use() guidance remains unchanged.

Changes

useInfiniteQuery documentation markers

Layer / File(s) Summary
Add ReactUse markers
docs/framework/react/reference/useInfiniteQuery.md, docs/framework/vue/reference/useInfiniteQuery.md
Added paired ReactUse documentation markers to both reference pages. The React markers surround the existing React.use() guidance.

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

Merge Risk: ⚪ Minimal · up to d8fce

This documentation-only change hides a React-specific note from the Vue reference page while preserving the React page; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description explains the documentation change, motivation, validation, checklist status, and release impact.
Title check ✅ Passed The title clearly identifies the Vue documentation reference and the React-only mention being hidden.
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/hide-react-use-from-vue-infinite-query

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

nx-cloud Bot commented Aug 16, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit d8fce1e

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

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

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

@sukvvon sukvvon self-assigned this Aug 16, 2026
@pkg-pr-new

pkg-pr-new Bot commented Aug 16, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: d8fce1e

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@sukvvon
sukvvon merged commit 6423f9e into main Aug 16, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/hide-react-use-from-vue-infinite-query branch August 16, 2026 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant