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

Build out documentation #1

Open
mike12345567 opened this issue Feb 21, 2021 · 0 comments
Open

Build out documentation #1

mike12345567 opened this issue Feb 21, 2021 · 0 comments
Assignees
@mike12345567
Labels
enhancement New feature or request

Comments

@mike12345567
Copy link
Owner

Currently the API is mostly undocumented, want to build this out properly with JSDoc. Need to look at the best way to do this, thinking that should be able to document each of the operations prototypal classes and then extract these to a markdown file which can be added to the README.
@mike12345567 mike12345567 added the enhancement New feature or request label Feb 21, 2021
@mike12345567 mike12345567 self-assigned this Feb 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mike12345567 mike12345567

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mike12345567