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.

Sign up for GitHub

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

Jump to bottom

Do we have API reference documentation? #56

Open
pastelmind opened this issue Apr 18, 2021 · 0 comments
Open

Do we have API reference documentation? #56

pastelmind opened this issue Apr 18, 2021 · 0 comments

Comments

@pastelmind
Copy link

pastelmind commented Apr 18, 2021 •
edited
Loading

It seems that we don't have API reference documentation. The examples in the README are thorough, but an API Reference section like SWR or React Query would help us quickly look up parameters. It wouldn't have to be large and comprehensive; just 1-2 sentences per each property returned from useAsync() would be fine.

If you need assistance writing a docs section, I'm willing to help. Although I am no expert in documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pastelmind