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 TSDoc comments to describe arguments/props so the descriptions will appear in IntelliSense #113

Open
mturley opened this issue Sep 2, 2022 · 0 comments

Comments

@mturley
Copy link
Collaborator

mturley commented Sep 2, 2022

https://tsdoc.org/ is a good way to document the use of each argument/prop in a function/component, and those comments will appear when typing a function call in an editor that supports IntelliSense (such as VS Code).

We could add general descriptions of each prop, but we can also use that as a place for recommendations/warnings about the use of certain props (see #112 for an example).

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