-
-
Notifications
You must be signed in to change notification settings - Fork 8.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for reactivity functions #4832
Labels
🍰 p2-nice-to-have
Priority 2: this is not breaking anything but nice to have it addressed.
has PR
A pull request has already been submitted to solve the issue
Comments
PR will come tomorrow as it's too late now 😅 |
Thanks to @atomjar for encouraging me to finally stop procrastinating and start contributing instead 🦄 |
haoqunjiang
added
has PR
A pull request has already been submitted to solve the issue
🍰 p2-nice-to-have
Priority 2: this is not breaking anything but nice to have it addressed.
labels
Mar 14, 2023
yyx990803
pushed a commit
that referenced
this issue
Mar 31, 2023
IAmSSH
pushed a commit
to IAmSSH/core
that referenced
this issue
May 14, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
🍰 p2-nice-to-have
Priority 2: this is not breaking anything but nice to have it addressed.
has PR
A pull request has already been submitted to solve the issue
What problem does this feature solve?
When building anything that relies on the new awesome reactivity API, one is constantly calling the different functions like
ref
,reactive
,computed
etc. (obviously). These function are explained on https://v3.vuejs.org/api/reactivity-api.html, true.But some of them are lacking actual code documentation - which means the generated type definitions are lacking documentation, as well.
It would be a nice touch if we had those docs, though, as it would allow IDEs to provide us with quick documentation lookup!
What does the proposed API look like?
Given some explanations on the inner workings, I could provide some proper code documentation. It's not a big thing, but it might make life easier for quite a few people out there :)
The text was updated successfully, but these errors were encountered: