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

Polish the auto generated API docs to include type info and fix broken links in it + add more documentation in API level #53

Open
3p3r opened this issue Apr 3, 2020 · 0 comments
Open

Polish the auto generated API docs to include type info and fix broken links in it + add more documentation in API level #53

3p3r opened this issue Apr 3, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@3p3r
Copy link
Contributor

3p3r commented Apr 3, 2020

The API docs that are auto generated are pathetic currently and it's mostly jsdoc2md's fault. LOTS of polish needs to be done here so it can be usable. Types must be added and more docs in the code level for constructs.
@3p3r 3p3r added the enhancement New feature or request label Apr 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@3p3r