Skip to content

docs(preact-query): define 'App' before 'ErrorBoundary' in 'QueryErrorResetBoundary' example - #11338

Merged
sukvvon merged 1 commit into
mainfrom
docs/preact-query-query-error-reset-boundary-example-order
Aug 30, 2026
Merged

docs(preact-query): define 'App' before 'ErrorBoundary' in 'QueryErrorResetBoundary' example#11338
sukvvon merged 1 commit into
mainfrom
docs/preact-query-query-error-reset-boundary-example-order

Conversation

@sukvvon

@sukvvon sukvvon commented Aug 30, 2026

Copy link
Copy Markdown
Member

🎯 Changes

QueryErrorResetBoundary's @example defined ErrorBoundary before App, the reverse of the ordering used across useSuspenseQuery/useSuspenseInfiniteQuery/useSuspenseQueries (#11337), where the main component tree (App) is shown first and the auxiliary ErrorBoundary implementation follows.

  • QueryErrorResetBoundary.tsx: reordered the example so App is defined before ErrorBoundary, matching that convention
  • Regenerated docs/framework/preact/reference/functions/QueryErrorResetBoundary.md with pnpm run generate-docs

✅ 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).

Summary by CodeRabbit

  • Documentation
    • Reorganized the QueryErrorResetBoundary example for improved readability and consistency.
    • No user-facing functionality or API behavior changed.

@nx-cloud

nx-cloud Bot commented Aug 30, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 0c9b669

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

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

@coderabbitai

coderabbitai Bot commented Aug 30, 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 803fb7d4-1388-4e81-9a0e-1b6eb51acc26

📥 Commits

Reviewing files that changed from the base of the PR and between 9633f79 and 0c9b669.

📒 Files selected for processing (2)
  • docs/framework/preact/reference/functions/QueryErrorResetBoundary.md
  • packages/preact-query/src/QueryErrorResetBoundary.tsx

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


📝 Walkthrough

Walkthrough

The App example now appears before the ErrorBoundary definition in the QueryErrorResetBoundary JSDoc and Preact reference documentation. The example content and runtime behavior remain unchanged.

Changes

QueryErrorResetBoundary example ordering

Layer / File(s) Summary
Reorder App example
packages/preact-query/src/QueryErrorResetBoundary.tsx, docs/framework/preact/reference/functions/QueryErrorResetBoundary.md
The App example was moved before the ErrorBoundary definition in both documentation locations. No example content changed.

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

Merge Risk: ⚪ Minimal · up to 0c9b6

This change only rearranges the QueryErrorResetBoundary documentation example so App appears before ErrorBoundary; it does not change published behavior or runtime code. No actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description explains the documentation-only change, its motivation, affected files, documentation regeneration, checklist status, testing status, and release impact.
Title check ✅ Passed The title clearly and concisely identifies the main change: defining App before ErrorBoundary in the QueryErrorResetBoundary example.
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.
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 1 files. (1 skipped: 1 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-query-error-reset-boundary-example-order

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

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

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

@pkg-pr-new

pkg-pr-new Bot commented Aug 30, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 0c9b669

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.89 KB (0%)
react minimal 8.85 KB (0%)

@sukvvon sukvvon self-assigned this Aug 30, 2026
@sukvvon
sukvvon merged commit 87fa4c1 into main Aug 30, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/preact-query-query-error-reset-boundary-example-order branch August 30, 2026 17:52
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