docs(lit): fix casing typos and broken syntax in quick-start - #2252
Merged
Conversation
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.
📝 WalkthroughWalkthroughThe Lit Quick Start documentation now consistently uses ChangesLit Quick Start
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
TanStackFormControllercasing in introductory text (wasTanstackFormController). - Fix invalid generic syntax in the example (
new TanStackFormController<Employee>(...)). - Correct casing again in the later explanation of the
fieldmethod.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
Sorry for the delay! Appreciate the typo fixes! |
|
View your CI Pipeline Execution ↗ for commit 356783f
☁️ Nx Cloud last updated this comment at |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three fixes in the Lit quick-start: (1) TanstackFormController → TanStackFormController (line 6, prose). (2)
ew TanStackFormController()(this, …) →
ew TanStackFormController(this, …) (line 16, code — the angle brackets after () parsed as a separate call and wouldn't compile). (3) TanstackFormController → TanStackFormController (line 28, prose). All three in the same file.