Skip to content

docs(react): fix incorrect form component reference in code comment#2126

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

docs(react): fix incorrect form component reference in code comment#2126
andycochrane wants to merge 1 commit intoTanStack:mainfrom
andycochrane:patch-1

Conversation

@andycochrane
Copy link
Copy Markdown

@andycochrane andycochrane commented Apr 15, 2026

🎯 Changes

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm 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
    • Updated form composition guide examples to reflect current component naming conventions.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 15, 2026

📝 Walkthrough

Walkthrough

A documentation example comment was updated to reflect a component name change from CustomSubmit to SubmitButton in a form composition guide. The underlying code semantics remain unchanged; only the descriptive comment text was modified.

Changes

Cohort / File(s) Summary
Documentation Update
docs/framework/react/guides/form-composition.md
Updated inline TypeScript error comment in the ProfileForm.extendForm example to reference the correct component name (SubmitButton instead of CustomSubmit).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A comment fixed with gentle care,
From CustomSubmit to Button fair,
The words now ring both true and clear,
No logic changed, just polished here! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: correcting an incorrect form component reference in a code comment in the React documentation.
Description check ✅ Passed The description follows the template structure with all required sections present, though the 'Changes' section lacks detail about what was actually fixed.
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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/framework/react/guides/form-composition.md (1)

226-226: Documentation fix looks good!

The comment now correctly references SubmitButton to match the actual component name used in the code example (lines 191, 222, 227), improving documentation accuracy.

Optional: Minor style suggestion

Consider capitalizing "TS" for consistency with common TypeScript abbreviation conventions:

-  // Ts will error since the parent appForm already has a component called SubmitButton
+  // TS will error since the parent appForm already has a component called SubmitButton
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/framework/react/guides/form-composition.md` at line 226, Update the
inline comment that currently reads "Ts will error since the parent appForm
already has a component called SubmitButton" to use the correct capitalization
"TS" (e.g., "TS will error since the parent appForm already has a component
called SubmitButton") so the TypeScript abbreviation is consistent; locate the
comment near the SubmitButton examples in the form-composition guide (references
to SubmitButton around the example blocks) and replace "Ts" with "TS".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/framework/react/guides/form-composition.md`:
- Line 226: Update the inline comment that currently reads "Ts will error since
the parent appForm already has a component called SubmitButton" to use the
correct capitalization "TS" (e.g., "TS will error since the parent appForm
already has a component called SubmitButton") so the TypeScript abbreviation is
consistent; locate the comment near the SubmitButton examples in the
form-composition guide (references to SubmitButton around the example blocks)
and replace "Ts" with "TS".

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a11e1dd5-bf1e-46a3-a0ff-db11c87e687a

📥 Commits

Reviewing files that changed from the base of the PR and between 254f157 and 547bbcc.

📒 Files selected for processing (1)
  • docs/framework/react/guides/form-composition.md

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