Skip to content
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

Closed
defaude opened this issue Oct 21, 2021 · 3 comments · Fixed by #4836
Closed

Add documentation for reactivity functions #4832

defaude opened this issue Oct 21, 2021 · 3 comments · Fixed by #4836
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

@defaude
Copy link
Contributor

defaude commented Oct 21, 2021

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 :)

@defaude
Copy link
Contributor Author

defaude commented Oct 21, 2021

As an example how this could (should?) look, here's me hitting F1 in intelliJ while the cursor is on the computed method call:

quick-doc-lookup

@defaude
Copy link
Contributor Author

defaude commented Oct 21, 2021

PR will come tomorrow as it's too late now 😅

@defaude
Copy link
Contributor Author

defaude commented Oct 21, 2021

Thanks to @atomjar for encouraging me to finally stop procrastinating and start contributing instead 🦄

@sodatea sodatea 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
@github-actions github-actions bot locked and limited conversation to collaborators Sep 12, 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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants