[v2] Docs: Add JSDoc to code and API section to website - #2331
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit f3571fd
☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version Preview1 package(s) bumped directly, 12 bumped as dependents. 🟩 Patch bumps
|
|
Important Review skippedToo many files! This PR contains 542 files, which is 242 over the limit of 300. To get a review, reduce the PR to 300 files or fewer by splitting it into smaller PRs or changing its base branch. Usage-priced reviews support at most 300 files. ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (542)
You can disable this status message by setting the 📝 WalkthroughWalkthroughThe pull request expands TSDoc for form, field, array, listener, and framework APIs. It reorganizes API documentation navigation and adds a patch changeset for ChangesForm API documentation
Estimated code review effort: 3 (Moderate) | ~25 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/config.json`:
- Around line 361-482: Add the missing Field API Reference navigation group
alongside the existing Form API and listener groups in the configuration.
Include links for FieldApi, FieldOptions, FieldState, and the documented field
methods, using their generated reference targets and keeping the existing
collapsible/default-collapsed structure.
In `@packages/form-core/src/FormApi/FormApi.public.ts`:
- Around line 617-626: Update the handleSubmit documentation around its
validation error behavior and `@returns` description to include OnSubmitError
values produced by parseIssues alongside createValidationError results. Ensure
both descriptions state that parseIssues results can be returned from onSubmit
and are stored and included in the returned error results.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: d504b14e-c8e2-4961-9fd1-25fa6ea1221a
📒 Files selected for processing (13)
.changeset/legal-animals-design.mddocs/config.jsonpackages/angular-form/src/form-type.tspackages/form-core/src/FormApi/FormApi.public.tspackages/form-core/src/FormApi/FormApiArrayMethods.types.public.tspackages/form-core/src/FormApi/FormApiFieldMethods.types.public.tspackages/form-core/src/listeners.public.tspackages/form-core/src/types.public.tspackages/lit-form/src/get-form-type.tspackages/preact-form/src/PreactForm/formType.public.tspackages/react-form/src/ReactForm/formType.public.tspackages/solid-form/src/formType.public.tspackages/vue-form/src/VueForm/formType.public.ts
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## alpha #2331 +/- ##
========================================
Coverage ? 95.17%
========================================
Files ? 64
Lines ? 3482
Branches ? 831
========================================
Hits ? 3314
Misses ? 160
Partials ? 8 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
2 participants
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.
Summary by CodeRabbit