docs: remove nonexistent setFormError and duplicate setValues from FormApi reference - #494
Open
ZayanKhan-12 wants to merge 1 commit into
Open
docs: remove nonexistent setFormError and duplicate setValues from FormApi reference#494ZayanKhan-12 wants to merge 1 commit into
ZayanKhan-12 wants to merge 1 commit into
Conversation
…rmApi reference The FormApi reference documented setFormError, which does not exist: it is not on the formApi object in FormController.js, not in the FormApi type in index.d.ts, and not referenced by any test. setValues was also documented twice with different descriptions. The implementation iterates all registered fields and sets each from the given object (clearing fields you don't include), which is what the retained row says; the removed row described it as a per-field setter. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Two fixes to the FormApi reference page (
vitedocs/Pages/ApiReference/FormApi/FormApi.jsx), which is routed live at/formApi:setFormErrordoesn't exist. It's documented with an example (setFormError('There was an error!')), but it's not on theformApiobject inFormController.js, not in theFormApitype inindex.d.ts, and not referenced by any test (grep -rn setFormError src/ index.d.ts __tests__→ zero hits). Removed the row.setValuesis documented twice with different descriptions. The implementation iterates all registered fields and sets each from the given object — i.e. it clears fields you don't include — which matches the retained row. The removed duplicate described it as a per-field setter (setValues({ greeting: 'hello'})/ "set the fields values"), which better describessetTheseValues, documented just below.🤖 Generated with Claude Code