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

Make documentation for the API #77

Open
keithradford opened this issue Feb 4, 2021 · 0 comments
Open

Make documentation for the API #77

keithradford opened this issue Feb 4, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@keithradford
Copy link
Collaborator

As a user of the API, it would be nice if there was detailed documentation somewhere that I could refer to to help in getting started as well as to use as reference.

The current implementation uses JSDoc syntax on all the functions, so this should be pretty straight forward. It does not have to be overly complicated or in depth, just a neat reference for users.
@keithradford keithradford added the documentation Improvements or additions to documentation label Feb 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@keithradford