Conversation
Contributor
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. 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 (71)
💤 Files with no reviewable changes (70)
Included review availability: Your plan provides up to 10 included reviews per hour; 5 remain after this review. 📝 WalkthroughWalkthroughThe TypeDoc configuration now excludes protected members. Generated Angular, Lit, Preact, React, Solid, Svelte, and Vue reference pages remove protected and inherited member entries. Runtime code and public API behavior are unchanged. ChangesProtected API documentation cleanup
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Other Merge Risk: ⚪ Minimal · up to This change removes protected members from generated reference documentation while preserving runtime behavior and the public API; it is ready to merge. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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 |
|
View your CI Pipeline Execution ↗ for commit badf19c
☁️ 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. |
Contributor
size-limit report 📦
|
5 tasks
…d-from-reference # Conflicts: # docs/framework/angular/reference/classes/InfiniteQueryObserver.md # docs/framework/angular/reference/classes/Mutation.md # docs/framework/angular/reference/classes/MutationCache.md # docs/framework/angular/reference/classes/MutationObserver.md # docs/framework/angular/reference/classes/QueriesObserver.md # docs/framework/angular/reference/classes/Query.md # docs/framework/angular/reference/classes/QueryCache.md # docs/framework/angular/reference/classes/QueryObserver.md # docs/framework/lit/reference/classes/InfiniteQueryObserver.md # docs/framework/lit/reference/classes/Mutation.md # docs/framework/lit/reference/classes/MutationCache.md # docs/framework/lit/reference/classes/MutationObserver.md # docs/framework/lit/reference/classes/QueriesObserver.md # docs/framework/lit/reference/classes/Query.md # docs/framework/lit/reference/classes/QueryCache.md # docs/framework/lit/reference/classes/QueryObserver.md # docs/framework/preact/reference/classes/InfiniteQueryObserver.md # docs/framework/preact/reference/classes/Mutation.md # docs/framework/preact/reference/classes/MutationCache.md # docs/framework/preact/reference/classes/MutationObserver.md # docs/framework/preact/reference/classes/QueriesObserver.md # docs/framework/preact/reference/classes/Query.md # docs/framework/preact/reference/classes/QueryCache.md # docs/framework/preact/reference/classes/QueryObserver.md # docs/framework/react/reference/classes/InfiniteQueryObserver.md # docs/framework/react/reference/classes/Mutation.md # docs/framework/react/reference/classes/MutationCache.md # docs/framework/react/reference/classes/MutationObserver.md # docs/framework/react/reference/classes/QueriesObserver.md # docs/framework/react/reference/classes/Query.md # docs/framework/react/reference/classes/QueryCache.md # docs/framework/react/reference/classes/QueryObserver.md # docs/framework/solid/reference/classes/InfiniteQueryObserver.md # docs/framework/solid/reference/classes/Mutation.md # docs/framework/solid/reference/classes/MutationCache.md # docs/framework/solid/reference/classes/MutationObserver.md # docs/framework/solid/reference/classes/QueriesObserver.md # docs/framework/solid/reference/classes/Query.md # docs/framework/solid/reference/classes/QueryCache.md # docs/framework/solid/reference/classes/QueryObserver.md # docs/framework/svelte/reference/classes/InfiniteQueryObserver.md # docs/framework/svelte/reference/classes/Mutation.md # docs/framework/svelte/reference/classes/MutationCache.md # docs/framework/svelte/reference/classes/MutationObserver.md # docs/framework/svelte/reference/classes/QueriesObserver.md # docs/framework/svelte/reference/classes/Query.md # docs/framework/svelte/reference/classes/QueryCache.md # docs/framework/svelte/reference/classes/QueryObserver.md # docs/framework/vue/reference/classes/InfiniteQueryObserver.md # docs/framework/vue/reference/classes/Mutation.md # docs/framework/vue/reference/classes/MutationCache.md # docs/framework/vue/reference/classes/MutationObserver.md # docs/framework/vue/reference/classes/QueriesObserver.md # docs/framework/vue/reference/classes/Query.md # docs/framework/vue/reference/classes/QueryCache.md # docs/framework/vue/reference/classes/QueryObserver.md
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.tsalready tells TypeDoc to drop private and@internalmembers, but not protected ones:So the reference pages documented internals that callers can't reach —
Query.scheduleGc(),QueryObserver.bindMethods(),InfiniteQueryObserver.createResult()and friends. Several rendered their modifier right in the signature, e.g.protected fetch: ReplaceReturnType<…>.Adding the option removes 217 method/property entries and 5,096 lines across the seven adapters, without touching any public API.
What disappears
Every removed member is declared
protectedinquery-core:onSubscribe,onUnsubscribe,listenerssubscribable.tsscheduleGc,updateGcTime,clearGcTimeoutremovable.tsoptionalRemovemutation.tsbindMethods,createResult,fetch(property)infiniteQueryObserver.tsfetch(method)queryObserver.tsNothing is added, and no public member is dropped.
fetchis the case worth checking:QueryObserver.fetchis protected and goes, whileQuery.fetchis public and stays — the option keys off the modifier, not the name.Effect
classes/QueryObserver.mdWhy this hides currently-published members
Opened as a draft, now ready, because it hides members that are currently published. The case for it is that these aren't callable from outside the class, so the pages describe implementation rather than API — but that's a maintainer call, and
hideInherited/hideSourcesin #11533 were decided the same way.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit