docs(preact-query): correct inaccurate JSDoc statements - #11367
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit ea9cc65
☁️ Nx Cloud last updated this comment at |
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (16)
Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review. 📝 WalkthroughWalkthroughThe PR updates Preact Query generated references and source JSDoc. It refreshes source links and clarifies query-function, infinite-query, suspense-query, mutation-filtering, and mutation-callback behavior. No runtime code or public declarations change. ChangesPreact Query documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This PR corrects inaccurate Preact Query documentation and regenerates the corresponding reference pages without changing executable behavior or public type signatures. No actionable merge-blocking risk remains beyond normal checks and review. Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation 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 6 files. (10 skipped: 10 unsupported.) ✨ 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 |
Contributor
🚀 Changeset Version Preview2 package(s) bumped directly, 23 bumped as dependents. 🟨 Minor bumps
🟩 Patch bumps
|
Contributor
size-limit report 📦
|
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
Corrects 6 inaccurate JSDoc statements in
packages/preact-query/src/, and regenerates the affected reference docs underdocs/framework/preact/reference/to match.mutationOptions.ts: without amutationKey, a mutation can still be targeted via otheruseMutationStatefilters (e.g.status) — it's only amutationKeyfilter that can't reach it.queryOptions.ts/infiniteQueryOptions.ts: thequeryFn-omission guidance no longer implies a default query function defers a fetch the wayenabled: falsedoes — omittingqueryFnalone still triggers a fetch that fails with "Missing queryFn" unlessenabledisfalseor a default query function has been defined.useInfiniteQuery.ts(3 overloads):queryFnis also accepted byuseQuery, so it isn't somethinguseInfiniteQuery"adds" — removed from that list.useMutation.ts:mutate's@returnsdocs now distinguish hook-level callbacks (fire on every mutation) from per-call callbacks (fire only for the latest call, and only while still mounted).useSuspenseQueries.ts(2 overloads): the top-levelsubscribedoption fromuseQueriesisn't supported here either — added to the list of unsupported options alongsidethrowOnError/enabled/placeholderData.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit
queryFnis omitted, including failed fetches and the use ofenabled: false.useSuspenseQueriesdoes not support the top-levelsubscribedoption.