docs: update docs for deep property of useStore to match the new default
#6383
Conversation
This file contains 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
Changes are made in JSDoc, API json and API docs
👷 Deploy request for qwik-insights pending review.Visit the deploys page to approve it
|
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.
Overview
Changes are made in JSDoc, API json and API docs.
What is it?
Description
In #3678 the
useStoreis made recursive by default. The JSDoc and API description for thedeepproperty ofUseStoreOptionswere not yet updated to match this.Use cases and why
The conflicting docs can be confusing as it insinuates that deep reactivity still has to be enabled manually. Especially the outdated JSDoc makes for a confusing IntelliSense in code editors.
Checklist: