docs(angular-query-experimental): add JSDoc to the exported classes, methods, and arrow functions by sukvvon · Pull Request #11884 · TanStack/query

sukvvon · 2026-10-04T03:17:40Z

🎯 Changes

Adds JSDoc (description, @param, @returns) to the exported classes, their non-private methods, and the exported arrow functions that didn't have one:

angular-query-experimental: injectDevtoolsPanel, withDevtools

The // comments above them are folded into the new JSDoc.

None of these are part of the generated reference docs.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

This change affects published code, and I have generated a changeset.
This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

Documentation
- Clarified developer-facing documentation about devtools behavior in production builds, including the behavior of the returned integrations. No functionality or runtime behavior changed.

…methods, and arrow functions

changeset-bot · 2026-10-04T03:17:45Z

⚠️ No Changeset found

Latest commit: 3adf0c3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

nx-cloud · 2026-10-04T03:18:07Z

View your CI Pipeline Execution ↗ for commit 17928c2

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	3m 55s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	5s	View ↗

☁️ Nx Cloud last updated this comment at 2026-10-04 03:22:42 UTC

github-actions · 2026-10-04T03:18:35Z

🚀 Changeset Version Preview

1 package(s) bumped directly, 24 bumped as dependents.

🟩 Patch bumps

Package	Version	Reason
`@tanstack/query-core`	5.104.1 → 5.104.2	Changeset
`@tanstack/angular-query-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/angular-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/eslint-plugin-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/lit-query`	0.2.26 → 0.2.27	Dependent
`@tanstack/preact-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-async-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-broadcast-client-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-persist-client-core`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-sync-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-next-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/svelte-query`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-devtools`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-persist-client`	6.3.1 → 6.3.2	Dependent
`@tanstack/vue-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/vue-query-devtools`	6.3.1 → 6.3.2	Dependent

coderabbitai · 2026-10-04T03:19:45Z

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 17 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 10 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: 8b409a05-dd5d-43ef-b7af-4bcec74b8f72

📥 Commits

Reviewing files that changed from the base of the PR and between 17928c2 and 3adf0c3.

📒 Files selected for processing (2)

packages/angular-query-experimental/src/devtools-panel/stub.ts
packages/angular-query-experimental/src/devtools/stub.ts

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: 72029fe5-2b6f-4d85-a0b0-5be95eb799db

📥 Commits

Reviewing files that changed from the base of the PR and between 5a8fa03 and 17928c2.

📒 Files selected for processing (2)

packages/angular-query-experimental/src/devtools-panel/stub.ts
packages/angular-query-experimental/src/devtools/stub.ts

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 0 remain after this review.

📝 Walkthrough

Walkthrough

The comments for the Angular devtools and devtools-panel production stubs now describe their replacement behavior and return values. The implementations are unchanged.

Changes

Angular devtools stub documentation

Layer / File(s)	Summary
Document production stub behavior `packages/angular-query-experimental/src/devtools/stub.ts`, `packages/angular-query-experimental/src/devtools-panel/stub.ts`	JSDoc comments describe the production replacement behavior and return values of both stubs. Stub implementations are unchanged.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 17928

The change clarifies production-stub documentation without changing runtime behavior. No concrete merge-blocking risk is established.

Architecture Summary

Architecture risk: 🔵 Low · up to 17928

The change affects 1 system.

Changed systems: packages/angular-query-experimental

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

observed — packages/angular-query-experimental (library) was modified; 2 changed files map to changed impact.

Before / after behavior

observed — Modified behavior in packages/angular-query-experimental/src/devtools-panel/stub.ts: The comment now describes the production replacement behavior and adds an @returns annotation; the stub implementation is unchanged.
observed — Modified behavior in packages/angular-query-experimental/src/devtools/stub.ts: The previous one-line stub comment was replaced with JSDoc describing the production-build replacement and its no-provider return value; no implementation changed.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title describes the JSDoc changes, but it is broader than the changes shown, which update two exported functions in angular-query-experimental.
Description check	✅ Passed	The description covers the changes, includes all template sections, and completes the checklist and release-impact information.
Docstring Coverage	✅ Passed	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 2…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

pkg-pr-new · 2026-10-04T03:20:37Z

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@11884

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@11884

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11884

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@11884

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@11884

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@11884

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@11884

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@11884

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@11884

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@11884

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@11884

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@11884

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@11884

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@11884

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@11884

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@11884

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@11884

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@11884

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@11884

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@11884

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@11884

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@11884

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@11884

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@11884

commit: 17928c2

github-actions · 2026-10-04T03:20:49Z

size-limit report 📦

Path	Size
react full	11.73 KB (0%)
react minimal	8.58 KB (0%)

docs(angular-query-experimental): add JSDoc to the exported classes, …

17928c2

…methods, and arrow functions

sukvvon self-assigned this Oct 4, 2026

Merge branch 'main' into docs/angular-query-jsdoc-members

3adf0c3

sukvvon merged commit 51b43f8 into main Oct 4, 2026
8 checks passed

sukvvon deleted the docs/angular-query-jsdoc-members branch October 4, 2026 03:36

Navigation Menu

Uh oh!

docs(angular-query-experimental): add JSDoc to the exported classes, methods, and arrow functions - #11884

docs(angular-query-experimental): add JSDoc to the exported classes, methods, and arrow functions#11884
sukvvon merged 2 commits into
mainfrom
docs/angular-query-jsdoc-members

sukvvon commented Oct 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading

Review limit reached

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

sukvvon commented Oct 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

nx-cloud Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 4, 2026

🚀 Changeset Version Preview

🟩 Patch bumps

Uh oh!

coderabbitai Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Walkthrough

Changes

Architecture Summary

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026

Uh oh!

github-actions Bot commented Oct 4, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 4, 2026 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Oct 4, 2026 •

edited

Loading

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading