Skip to content

Add documentation for reactivity functions #4832

@defaude

Description

@defaude

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    🍰 p2-nice-to-havePriority 2: this is not breaking anything but nice to have it addressed.has PRA pull request has already been submitted to solve the issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions