Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: TanStack/query/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
Included review availability: Your plan provides up to 10 included reviews per hour; 5 remain after this review. 📝 WalkthroughWalkthroughThe PR expands Solid query and mutation documentation. It describes query fetching, caching, refetch synchronization, and mutation usage. It also updates source links to match changed line numbers. ChangesSolid API documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
|
View your CI Pipeline Execution ↗ for commit 2dd459c
☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version Preview1 package(s) bumped directly, 24 bumped as dependents. 🟩 Patch bumps
|
Contributor
size-limit report 📦
|
sukvvon
force-pushed
the
docs/solid-query-reference-summaries
branch
from
September 20, 2026 05:49
2dd459c to
35ea0b4
Compare
sukvvon
force-pushed
the
docs/solid-query-reference-summaries
branch
from
September 20, 2026 06:00
35ea0b4 to
38fdef8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 Changes
useQueryanduseMutationdocument every parameter and carry an@example, but their JSDoc opened with a tag (@seeand@paramrespectively), so TypeDoc had no summary to render and both reference pages started straight at a heading.Each gained one leading sentence; the existing tags are untouched:
useMutationreuses the sentence already shared by the React, Preact and Vue adapters, with "hook" written as "function" — the Solid docs rewrite that word viareplace: { 'hook': 'function' }, so the adapter doesn't call these hooks.useQuerygets a sentence written for this adapter. The other adapters have no shared summary to match here: their documented overload only states theinitialDatacondition, and Vue and Angular describe their own reactivity on top of it.The
initialDataoverload ofuseQueryalready had a summary and is unchanged.Generated docs
pnpm run generate-docsupdates 4 pages from these 2 source changes:functions/useQuery.mdandfunctions/useMutation.md, plusvariables/createQuery.mdandvariables/createMutation.md— thecreateXaliases inherit the JSDoc of the function they alias, so they pick up the summary too. The 3 deleted lines areDefined in:line-number shifts.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit