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 hook usage examples as jsdoc/tsdoc #2492

Open
hennessyevan opened this issue Apr 6, 2023 · 0 comments
Open

Add hook usage examples as jsdoc/tsdoc #2492

hennessyevan opened this issue Apr 6, 2023 · 0 comments

Comments

@hennessyevan
Copy link

hennessyevan commented Apr 6, 2023

Is your feature request related to a problem? Please describe.
To see examples for usage of a particular hook one needs to come to this repo taking them out of their flow.

image

Describe the solution you'd like
Examples and brief documentation should be in jsdoc/tsdoc format so that hook usage examples can be viewed in IDE by hovering over the hook.

image

Describe alternatives you've considered
Alternatively, just provide a link to the documentation for the hook

If I can get approval for this I'm happy to open a PR and contribute this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant