Skip to content

docs(svelte-query): regenerate reference docs to fix stale source line numbers - #11399

Merged
sukvvon merged 1 commit into
mainfrom
docs/svelte-query-regenerate-stale-reference
Sep 5, 2026
Merged

docs(svelte-query): regenerate reference docs to fix stale source line numbers#11399
sukvvon merged 1 commit into
mainfrom
docs/svelte-query-regenerate-stale-reference

Conversation

@sukvvon

@sukvvon sukvvon commented Sep 5, 2026

Copy link
Copy Markdown
Member

🎯 Changes

packages/svelte-query/src/types.ts gained 7 lines in #11356 (feat(svelte-query): add 'DefinedInitialDataInfiniteOptions' overload for 'createInfiniteQuery'/'infiniteQueryOptions'), but that PR's own history shows the generated reference docs were deliberately reverted (docs(svelte-query): drop generated reference doc changes from this type-only PR), leaving docs/framework/svelte/reference/type-aliases/*.md pointing at source line numbers that no longer match types.ts.

Since then, every pnpm run generate-docs run picks this up as a diff even on an unrelated branch — confirmed by running it on a clean main checkout with no other changes. This PR is just that regeneration: 17 files, all Defined in: .../types.ts#L<N> line numbers corrected to match current source, no content changes.

✅ 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 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
    • Updated source-reference links across Svelte type-alias documentation to point to the current definition locations.
    • Corrected links for several type aliases and their documented properties, including mutation state options and provider props.
    • No functional behavior, public APIs, or type definitions were changed.

@nx-cloud

nx-cloud Bot commented Sep 5, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 69b1746

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 47s View ↗

☁️ Nx Cloud last updated this comment at 2026-09-05 04:41:40 UTC

@coderabbitai

coderabbitai Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 0bd65d52-a7e7-42c7-9056-fd8031e441ab

📥 Commits

Reviewing files that changed from the base of the PR and between 3095086 and 69b1746.

📒 Files selected for processing (17)
  • docs/framework/svelte/reference/type-aliases/Accessor.md
  • docs/framework/svelte/reference/type-aliases/CreateBaseMutationResult.md
  • docs/framework/svelte/reference/type-aliases/CreateBaseQueryOptions.md
  • docs/framework/svelte/reference/type-aliases/CreateBaseQueryResult.md
  • docs/framework/svelte/reference/type-aliases/CreateInfiniteQueryOptions.md
  • docs/framework/svelte/reference/type-aliases/CreateInfiniteQueryResult.md
  • docs/framework/svelte/reference/type-aliases/CreateMutateAsyncFunction.md
  • docs/framework/svelte/reference/type-aliases/CreateMutateFunction.md
  • docs/framework/svelte/reference/type-aliases/CreateMutationOptions.md
  • docs/framework/svelte/reference/type-aliases/CreateMutationResult.md
  • docs/framework/svelte/reference/type-aliases/CreateQueryOptions.md
  • docs/framework/svelte/reference/type-aliases/CreateQueryResult.md
  • docs/framework/svelte/reference/type-aliases/DefinedCreateBaseQueryResult.md
  • docs/framework/svelte/reference/type-aliases/DefinedCreateQueryResult.md
  • docs/framework/svelte/reference/type-aliases/MutationStateOptions.md
  • docs/framework/svelte/reference/type-aliases/MutationTypeFromResult.md
  • docs/framework/svelte/reference/type-aliases/QueryClientProviderProps.md

Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review.


📝 Walkthrough

Walkthrough

The change updates source line references in Svelte type-alias documentation. No runtime code or public declarations changed.

Changes

Svelte type reference updates

Layer / File(s) Summary
Update source definition links
docs/framework/svelte/reference/type-aliases/*.md
Updated Defined in links for query, mutation, provider, accessor, and related type aliases and properties in packages/svelte-query/src/types.ts.

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

Merge Risk: ⚪ Minimal · up to 69b17

Svelte Query reference pages now link to the current locations of their type definitions. This changes documentation navigation only and presents no current merge-readiness risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: regenerating Svelte Query reference documentation to correct stale source line numbers.
Description check ✅ Passed The description explains the cause, scope, motivation, validation, checklist status, and release impact. It identifies the 17 documentation-only files and confirms that no published code changes are i…
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 0…
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/svelte-query-regenerate-stale-reference

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.

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

2 package(s) bumped directly, 23 bumped as dependents.

🟨 Minor bumps

Package Version Reason
@tanstack/svelte-query 6.1.48 → 6.2.0 Changeset
@tanstack/svelte-query-devtools 6.1.48 → 6.2.0 Dependent
@tanstack/svelte-query-persist-client 6.1.48 → 6.2.0 Dependent
@tanstack/vue-query-devtools 6.1.48 → 6.2.0 Dependent

🟩 Patch bumps

Package Version Reason
@tanstack/query-core 5.102.8 → 5.102.9 Changeset
@tanstack/angular-query-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/angular-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/eslint-plugin-query 5.102.8 → 5.102.9 Dependent
@tanstack/lit-query 0.2.20 → 0.2.21 Dependent
@tanstack/preact-query 5.102.8 → 5.102.9 Dependent
@tanstack/preact-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/preact-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/query-async-storage-persister 5.102.8 → 5.102.9 Dependent
@tanstack/query-broadcast-client-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/query-persist-client-core 5.102.8 → 5.102.9 Dependent
@tanstack/query-sync-storage-persister 5.102.8 → 5.102.9 Dependent
@tanstack/react-query 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-next-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/vue-query 5.102.8 → 5.102.9 Dependent

@pkg-pr-new

pkg-pr-new Bot commented Sep 5, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 69b1746

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.87 KB (0%)
react minimal 8.84 KB (0%)

@sukvvon sukvvon self-assigned this Sep 5, 2026
@sukvvon
sukvvon merged commit 85de9c3 into main Sep 5, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/svelte-query-regenerate-stale-reference branch September 5, 2026 04:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant