docs(preact-query): backtick bare code-symbol references in JSDoc ('QueryClient', 'suspense', 'throwOnError') by sukvvon · Pull Request #11290 · TanStack/query

sukvvon · 2026-08-25T14:33:17Z

🎯 Changes

Wraps bare code-symbol references in backticks across the package's JSDoc, found via a systematic audit against the codebase's existing backtick convention for types, fields, and literal values:

The QueryClient type name was bare in the @param queryClient description used throughout the package ("Use this to use/provide a custom QueryClient...") and in QueryClientProviderProps's client/children field docs. This wording was introduced verbatim in docs(preact-query): document functions and components with JSDoc for generated reference docs #11204 and repeated in every hook that accepts an optional queryClient argument — a single consistent fix across 13 source files (21 occurrences).
suspense and throwOnError — actual option field names from QueryObserverOptions — were bolded (**suspense**/**throwOnError**) instead of backticked in QueryErrorResetBoundary's summary.

Every other code-symbol reference in the package's JSDoc (types, fields, literals, package names) is already backtick-wrapped or {@link}-linked — these were the only gaps. Verified with pnpm run generate-docs and pnpm --filter @tanstack/preact-query run test:types.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
I fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

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

… JSDoc

nx-cloud · 2026-08-25T14:33:40Z

View your CI Pipeline Execution ↗ for commit ab40c94

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

☁️ Nx Cloud last updated this comment at 2026-08-25 15:11:23 UTC

coderabbitai · 2026-08-25T14:34:07Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 0a93973a-f86a-4eb5-aa7b-2bf8617d7c26

📥 Commits

Reviewing files that changed from the base of the PR and between e51bfdd and ab40c94.

📒 Files selected for processing (4)

docs/framework/preact/reference/functions/QueryErrorResetBoundary.md
docs/framework/preact/reference/type-aliases/QueryClientProviderProps.md
packages/preact-query/src/QueryClientProvider.tsx
packages/preact-query/src/QueryErrorResetBoundary.tsx

🚧 Files skipped from review as they are similar to previous changes (2)

docs/framework/preact/reference/type-aliases/QueryClientProviderProps.md
packages/preact-query/src/QueryClientProvider.tsx

Included review availability: Your plan provides up to 10 included reviews per hour; 5 remain after this review.

📝 Walkthrough

Walkthrough

The PR updates Preact QueryClient references and QueryErrorResetBoundary option names in source JSDoc and framework reference documentation. It changes formatting and capitalization only. No API, signature, or runtime changes are included.

Changes

Preact documentation

Layer / File(s)	Summary
Update source JSDoc references `packages/preact-query/src/*`	Source comments now format or capitalize `QueryClient` and related option names consistently across hooks, providers, hydration props, and error-boundary documentation.
Synchronize reference documentation `docs/framework/preact/reference/...`	Preact reference pages now format `QueryClient` consistently across parameters, properties, interfaces, and overloads. The error-boundary page uses inline code for `suspense` and `throwOnError`.

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

Merge Risk: ⚪ Minimal · up to ab40c

This is a localized documentation-only change that does not alter runtime behavior or published code; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
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.
Title check	✅ Passed	The title clearly identifies the Preact Query JSDoc formatting change and names the affected code-symbol references. It accurately summarizes the primary change.
Description check	✅ Passed	The description includes the required Changes, Checklist, and Release Impact sections. It explains the motivation, scope, validation performed, and confirms that the change is documentation-only.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 14 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/preact-query-backtick-queryclient

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

github-actions · 2026-08-25T14:34:26Z

🚀 Changeset Version Preview

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

pkg-pr-new · 2026-08-25T14:35:58Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: ab40c94

github-actions · 2026-08-25T14:36:22Z

size-limit report 📦

Path	Size
react full	11.97 KB (0%)
react minimal	8.92 KB (0%)

… 'suspense'/'throwOnError' in QueryErrorResetBoundary

docs(preact-query): wrap bare 'QueryClient' type name in backticks in…

e51bfdd

… JSDoc

sukvvon self-assigned this Aug 25, 2026

docs(preact-query): backtick 'QueryClient' in 'children' prop doc and…

ab40c94

… 'suspense'/'throwOnError' in QueryErrorResetBoundary

TkDodo approved these changes Aug 25, 2026

View reviewed changes

sukvvon changed the title ~~docs(preact-query): wrap bare 'QueryClient' type name in backticks in JSDoc~~ docs(preact-query): backtick bare code-symbol references in JSDoc ('QueryClient', 'suspense', 'throwOnError') Aug 25, 2026

sukvvon merged commit d09cf1d into main Aug 25, 2026
9 checks passed

sukvvon deleted the docs/preact-query-backtick-queryclient branch August 25, 2026 15:14

Navigation Menu

Uh oh!

Uh oh!

docs(preact-query): backtick bare code-symbol references in JSDoc ('QueryClient', 'suspense', 'throwOnError') - #11290

docs(preact-query): backtick bare code-symbol references in JSDoc ('QueryClient', 'suspense', 'throwOnError')#11290
sukvvon merged 2 commits into
mainfrom
docs/preact-query-backtick-queryclient

sukvvon commented Aug 25, 2026 •

edited

Loading

Uh oh!

nx-cloud Bot commented Aug 25, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 25, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

github-actions Bot commented Aug 25, 2026

Uh oh!

pkg-pr-new Bot commented Aug 25, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

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

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Uh oh!

github-actions Bot commented Aug 25, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 25, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sukvvon commented Aug 25, 2026 •

edited

Loading

nx-cloud Bot commented Aug 25, 2026 •

edited

Loading

coderabbitai Bot commented Aug 25, 2026 •

edited

Loading

pkg-pr-new Bot commented Aug 25, 2026 •

edited

Loading