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

Document all the various API bits. #99

Open
Pomax opened this issue Nov 1, 2020 · 1 comment
Open

Document all the various API bits. #99

Pomax opened this issue Nov 1, 2020 · 1 comment
Labels
documentation For all documentation related work. enhancement Making working code work better. help welcome Want to help out? Have a look at issues tagged with this label.

Comments

@Pomax
Copy link
Owner

Pomax commented Nov 1, 2020 •
edited
Loading

There's quite a bit to document, most of it "obviously" named, but some of it not. We need to get some API documentation going.

Ideally this would be autogenerated from source using something like jsdoc, but only if that's not crazily overly verbose.
@Pomax Pomax added help welcome Want to help out? Have a look at issues tagged with this label. enhancement Making working code work better. documentation For all documentation related work. labels Nov 1, 2020
@Pomax
Copy link
Owner Author

Pomax commented Jul 9, 2021

https://medium.com/swlh/creating-better-jsdoc-documentation-8b7a65744dcb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation For all documentation related work. enhancement Making working code work better. help welcome Want to help out? Have a look at issues tagged with this label.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Pomax