Update API entry for toRef to mention mutating props #1624
Merged
Conversation
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
|
✔️ Deploy Preview for vuejs ready! 🔨 Explore the source changes: 52913a8 🔍 Inspect the deploy log: https://app.netlify.com/sites/vuejs/deploys/623384bed505fe00088b10b2 😎 Browse the preview: https://deploy-preview-1624--vuejs.netlify.app |
NataliaTepluhina
approved these changes
Mar 21, 2022
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.
This is my attempt at addressing the concern raised in #1567.
The API entry for
toRefmentions using it to create refs from props. This change attempts to clarify that the usual restriction on not mutating a prop still applies, usingtoRefis not a fix for that.I've also made a few other tweaks to this entry:
stringwhen it meantnumber.toRef. Usually I wouldn't show the imports, but given the<script setup>tag was shown, I felt the import should be shown too.toRefwith optional properties was added back when props did not include omitted values. That has since been changed, so props now includes all props, even if they aren't passed. I've reworded that note to avoid mentioning props.