Skip to content

docs(lit): fix casing typos and broken syntax in quick-start#2252

Open
kushaim wants to merge 1 commit into
TanStack:mainfrom
kushaim:docs/lit-quickstart-typo
Open

docs(lit): fix casing typos and broken syntax in quick-start#2252
kushaim wants to merge 1 commit into
TanStack:mainfrom
kushaim:docs/lit-quickstart-typo

Conversation

@kushaim

@kushaim kushaim commented Jul 21, 2026

Copy link
Copy Markdown

🎯 Changes

The Lit framework quick-start had three bugs in the same file:

  1. Line 6 (text): `TanstackFormController` (lowercase s). The class is TanStackFormController per packages/lit-form/src/tanstack-form-controller.ts. Same casing is used correctly on lines 16 and 40.

  2. Line 16 (code): new TanStackFormController()<Employee>(this, ...). The angle brackets form a separate call on the result of the constructor — invalid TypeScript. The type parameter belongs on the constructor: new TanStackFormController<Employee>(this, ...).

  3. Line 28 (text): `TanstackFormController` again, same lowercase s typo as line 6.

The casing typos are inconsistent with the rest of the file and would mislead anyone reading the intro text. The line 16 syntax error means a copy-pasted example would fail to compile. All three are fixed in this single commit.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm test:pr. (N/A — docs-only, no code paths affected)

🚀 Release Impact

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

The Lit framework quick-start had three bugs in the same file:

1. Line 6: 'create a \TanstackFormController\' (lowercase 's') in text.
   The class is named 'TanStackFormController' (capital 'S') per
   packages/lit-form/src/tanstack-form-controller.ts and is correctly
   cased on lines 16 and 40. Updated the text to match.

2. Line 16: 'new TanStackFormController()<Employee>(this, ...)'.
   The angle brackets form a separate call on the result of the
   constructor. The type parameter belongs on the constructor itself:
   'new TanStackFormController<Employee>(this, ...)'. As written, this
   would not compile.

3. Line 28: 'the \ield\ method of \TanstackFormController\' (lowercase
   's') in text. Same typo as line 6.

All three are corrected in one commit.
Copilot AI review requested due to automatic review settings July 21, 2026 23:05
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The Lit Quick Start documentation now consistently uses TanStackFormController, including its explanatory text, TypeScript example, and template-wiring instructions.

Changes

Lit Quick Start

Layer / File(s) Summary
Correct controller naming in the guide
docs/framework/lit/quick-start.md
Updates controller references and the example instantiation to use the corrected TanStackFormController identifier and casing.

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

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title accurately summarizes the Lit quick-start docs fixes: casing typos and invalid constructor syntax.
Description check ✅ Passed The description follows the template and includes changes, checklist items, and release impact details.
✨ 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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Fixes Lit quick-start documentation issues so readers see the correct controller name and can copy/paste a valid TypeScript example.

Changes:

  • Correct TanStackFormController casing in introductory text (was TanstackFormController).
  • Fix invalid generic syntax in the example (new TanStackFormController<Employee>(...)).
  • Correct casing again in the later explanation of the field method.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants