Conversation
…on pages and an overview to overloaded ones
|
View your CI Pipeline Execution ↗ for commit 9f59740
☁️ Nx Cloud last updated this comment at |
sukvvon
marked this pull request as draft
September 30, 2026 11:16
Contributor
🚀 Changeset Version PreviewNo changeset entries found. Merging this PR will not cause a version bump for any packages. |
Contributor
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. 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: trueNo 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 (104)
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe documentation generator now adds overload overviews, linked signature navigation, parameter and return summaries, and property tables to generated function references. The updated pages cover Angular, Lit, Preact, React, Solid, Svelte, and Vue APIs. ChangesGenerated reference documentation
Priority: ➖ Normal Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Possibly related PRs
Suggested reviewers: Merge Risk: ⚪ Minimal · up to The change adds navigation and property details to generated API references without changing runtime APIs. No actionable merge-blocking risk remains; merge after normal checks. Architecture SummaryArchitecture risk: 🟠 High · up to The change affects 2 systems. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
Reliability and maintainability
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 75.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 12 functions across 1 files. (103 skipped: 103 unsupported.) ✨ Finishing Touches 💡 1📝 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
size-limit report 📦
|
…t type has no property table
This branch has not been deployed
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
scripts/generate-docs.tsnow adds to every generated function page, without changing what TypeDoc renders:## Propertiestable of the type's own generated page. The script finds that page as follows:UseQueryResult→QueryObserverResult→QueryObserverBaseResult).Accessor<T> = () => T, inline() => T).## Overviewon overloaded pages with every call signature and a link to each one. The page also ends with## Parametersand## Returnssections, which repeat the most general signature's arguments and result together with their property tables.On single-signature pages, each table goes at the end of the section it describes. Property anchors in the added tables are prefixed with the table's name so they stay unique on the page.
The generated reference docs are regenerated. There are additions only, across 103 function pages.
✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit