docs(preact-query): document functions and components with JSDoc for generated reference docs - #11204
Draft
sukvvon wants to merge 1 commit into
Draft
docs(preact-query): document functions and components with JSDoc for generated reference docs#11204sukvvon wants to merge 1 commit into
sukvvon wants to merge 1 commit into
Conversation
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks 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 c069283
☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version PreviewNo changeset entries found. Merging this PR will not cause a version bump for any packages. |
4 tasks
Contributor
size-limit report 📦
|
sukvvon
force-pushed
the
docs/preact-reference-use-react-ref
branch
from
August 16, 2026 19:36
a36b236 to
0b75856
Compare
…generated reference docs
sukvvon
force-pushed
the
docs/preact-reference-use-react-ref
branch
from
August 24, 2026 09:12
df133ad to
c069283
Compare
sukvvon
changed the title
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
Adds JSDoc to
preact-query's functions and components (useQuery,useMutation,useInfiniteQuery,useSuspenseQuery,useSuspenseInfiniteQuery,useSuspenseQueries,useQueries,useIsFetching,useIsMutating,useMutationState,usePrefetchQuery,usePrefetchInfiniteQuery,queryOptions,infiniteQueryOptions,mutationOptions,QueryClientProvider,useQueryClient,QueryErrorResetBoundary,useQueryErrorResetBoundary,HydrationBoundary) so that the TypeDoc-generated reference docs underdocs/framework/preact/reference/carry the same descriptions, parameter notes, return-value notes, and caveats that the hand-writtendocs/framework/react/reference/docs already have.Where the React reference docs describe a
preact-query-owned parameter or return value (e.g. thequeryClientparameter, or the Suspense-variant caveats about cancellation not working), that text is ported verbatim. Where no example existed in the React docs, examples are adapted from working code inexamples/react/(basic,auto-refetching,nextjs-app-prefetching,load-more-infinite-scroll) and translated to Preact where the pattern differs (QueryErrorResetBoundary/useQueryErrorResetBoundaryuse Preact's ownuseErrorBoundaryhook instead ofreact-error-boundary, which has no Preact equivalent).Options inherited from
query-core(e.g.staleTime,retry,gcTime) are out of scope here —generate-docs.tsexcludesquery-corefrom the TypeDoc entry points for all four generated frameworks, so JSDoc added there wouldn't currently render on these pages regardless.Regenerated
docs/framework/preact/reference/withpnpm run generate-docsto pick up the new JSDoc; no other framework's output changed.✅ Checklist
pnpm run test:pr.🚀 Release Impact