Skip to content

docs(preact-query): import 'noop' from '@tanstack/preact-query' instead of '@tanstack/query-core' in examples - #11283

Merged
sukvvon merged 1 commit into
mainfrom
docs/preact-query-example-noop-import
Aug 25, 2026
Merged

docs(preact-query): import 'noop' from '@tanstack/preact-query' instead of '@tanstack/query-core' in examples#11283
sukvvon merged 1 commit into
mainfrom
docs/preact-query-example-noop-import

Conversation

@sukvvon

@sukvvon sukvvon commented Aug 25, 2026

Copy link
Copy Markdown
Member

🎯 Changes

Follow-up to #11204. The @example blocks in queryOptions.ts, infiniteQueryOptions.ts, and HydrationBoundary.tsx imported noop from @tanstack/query-core, but @tanstack/preact-query re-exports everything from @tanstack/query-core (export * from '@tanstack/query-core' in index.ts), so the examples can import noop directly from @tanstack/preact-query — the package the example already depends on — instead of adding an extra import from a package the example otherwise never references.

Regenerated docs/framework/preact/reference/ with pnpm run generate-docs to pick up the updated examples.

✅ 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
    • Updated Preact Query examples to use the recommended package import for noop.
    • Corrected source links and line references in API documentation.
    • No runtime behavior or public API changes.

@nx-cloud

nx-cloud Bot commented Aug 25, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit a9e8b2c

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

☁️ Nx Cloud last updated this comment at 2026-08-25 07:58:31 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 25, 2026
@pkg-pr-new

pkg-pr-new Bot commented Aug 25, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: a9e8b2c

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@coderabbitai

coderabbitai Bot commented Aug 25, 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: 8767248d-f450-44f0-bb6d-614ace166efd

📥 Commits

Reviewing files that changed from the base of the PR and between 870bd85 and a9e8b2c.

📒 Files selected for processing (6)
  • docs/framework/preact/reference/functions/HydrationBoundary.md
  • docs/framework/preact/reference/functions/infiniteQueryOptions.md
  • docs/framework/preact/reference/functions/queryOptions.md
  • packages/preact-query/src/HydrationBoundary.tsx
  • packages/preact-query/src/infiniteQueryOptions.ts
  • packages/preact-query/src/queryOptions.ts

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


📝 Walkthrough

Walkthrough

The PR updates Preact Query examples to import noop from @tanstack/preact-query. It also corrects source link line numbers in the related reference documentation.

Changes

Preact example updates

Layer / File(s) Summary
Package example imports
packages/preact-query/src/*
Example imports now source noop from @tanstack/preact-query.
Reference documentation synchronization
docs/framework/preact/reference/functions/*
Reference examples use the updated imports, and documented source links use current line numbers.

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

Merge Risk: ⚪ Minimal · up to a9e8b

This updates documentation examples to import noop from the package they already use and regenerates the corresponding references; no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main documentation change: importing noop from @tanstack/preact-query instead of @tanstack/query-core in examples.
Description check ✅ Passed The description explains the change and motivation, identifies regenerated documentation, completes all required checklist items, and correctly marks the change as docs-only with no release impact.
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 3…
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 3 files. (3 skipped: 3 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-example-noop-import

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.

@sukvvon
sukvvon merged commit 720725d into main Aug 25, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/preact-query-example-noop-import branch August 25, 2026 08:06
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