Skip to content

docs: fix incorrect children prop on svelte validation guide#2091

Open
Suya1671 wants to merge 1 commit intoTanStack:mainfrom
Suya1671:patch-1
Open

docs: fix incorrect children prop on svelte validation guide#2091
Suya1671 wants to merge 1 commit intoTanStack:mainfrom
Suya1671:patch-1

Conversation

@Suya1671
Copy link

@Suya1671 Suya1671 commented Mar 23, 2026

🎯 Changes

Removed a JSX children prop was left on the validation guide for Svelte's validation guide, which does not work and is duplicated as a correct snippet later in the code block.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm test:pr.
    • I don't think this change needs to be tested

🚀 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 validation guide examples to reflect simplified syntax patterns while maintaining equivalent functionality.

Removed a JSX `children` prop was left on the validation guide for Svelte's validation guide, which does not work and is duplicated as a correct snippet later in the code block.
@coderabbitai
Copy link

coderabbitai bot commented Mar 23, 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: 3a1f49e7-1a60-4ffd-9108-8b7bb19f63b5

📥 Commits

Reviewing files that changed from the base of the PR and between e21cc01 and 9e77e77.

📒 Files selected for processing (1)
  • docs/framework/svelte/guides/validation.md
💤 Files with no reviewable changes (1)
  • docs/framework/svelte/guides/validation.md

📝 Walkthrough

Walkthrough

Documentation example updated in Svelte validation guide. The <form.Subscribe> component example removed an inline children render prop, consolidating form submission button rendering logic into a single {#snippet children(state)} block while maintaining the same disabled state and label behavior.

Changes

Cohort / File(s) Summary
Documentation Example Update
docs/framework/svelte/guides/validation.md
Removed inline render prop pattern from form subscription example, consolidating button rendering into snippet syntax while preserving state-driven disabled state and label behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A snippet so fine, replaced the old way,
Cleaner Svelte code for form display,
No render props cluttering the view,
Just snippets and states, fresh and true,
The docs hopped along, simpler and bright, 🐰✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing an incorrect JSX children prop from the Svelte validation guide documentation.
Description check ✅ Passed The description covers the main changes and fills the required template sections, though testing checklist shows incomplete local testing acknowledgment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

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

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 and usage tips.

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