Skip to content

Fix formatting in Suspense guide example#10631

Closed
lucemans wants to merge 2 commits intoTanStack:mainfrom
lucemans:patch-1
Closed

Fix formatting in Suspense guide example#10631
lucemans wants to merge 2 commits intoTanStack:mainfrom
lucemans:patch-1

Conversation

@lucemans
Copy link
Copy Markdown

@lucemans lucemans commented May 3, 2026

🎯 Changes

I fixed a code snippet in solid-js docs

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • [-] I have tested this code locally with pnpm run test:pr.

🚀 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
    • Fixed a formatting issue in the Suspense guide documentation.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 3, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 929ccba5-96ea-4b34-bfb2-341668f89201

📥 Commits

Reviewing files that changed from the base of the PR and between 74fa05e and 8ea661a.

📒 Files selected for processing (1)
  • docs/framework/solid/guides/suspense.md

📝 Walkthrough

Walkthrough

A leading semicolon before a JSX element in a Suspense code example was removed from the documentation. The example now starts with the JSX tag directly without the preceding semicolon.

Changes

Documentation Syntax Fix

Layer / File(s) Summary
Code Example Cleanup
docs/framework/solid/guides/suspense.md
Removed leading semicolon from <Suspense> JSX element in the code example on line 12.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A tiny semicolon did hide,
Before the Suspense, sitting wide,
With one swift stroke, it flew away,
The syntax gleams in perfect sway! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: fixing formatting in a Suspense guide example, which matches the actual code modification (removing a leading semicolon).
Description check ✅ Passed The description follows the repository template with all required sections present and mostly complete, including changes summary, contributor checklist, and release impact assessment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented May 3, 2026

View your CI Pipeline Execution ↗ for commit 8ea661a

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

☁️ Nx Cloud last updated this comment at 2026-05-03 19:23:17 UTC

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 3, 2026

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: fe3f5ca

@sukvvon
Copy link
Copy Markdown
Collaborator

sukvvon commented May 3, 2026

autofix-ci re-added the ; (second commit) — Prettier inserts a defensive ; when a statement starts with <. The example would need a different shape to drop it. Closing as no-op.

@sukvvon sukvvon closed this May 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants