I started this task with the intent to just clean up the comments a little. I then discovered the wonders of jsdoc! I don't know if we want to do this, but I think I really like it.
Updated comments to meet jsdoc standards.
Added jsdoc plugin to eslint to enforce compliance.
Automatically generates API for README via jsdoc-to-markdown.
Updated the project description
Note: I attempted to tie in the creation of the README at the pre-commit hook, but because I believe it is async, the hook doesn't wait and the commit occurs before the new README is generated
I started this task with the intent to just clean up the comments a little. I then discovered the wonders of jsdoc! I don't know if we want to do this, but I think I really like it.
jsdoc
standards.jsdoc
plugin toeslint
to enforce compliance.jsdoc-to-markdown
.Note: I attempted to tie in the creation of the README at the pre-commit hook, but because I believe it is async, the hook doesn't wait and the commit occurs before the new README is generated
closes #33