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

[Documentation] JSDoc documentation for all functions #2

Open

1 of 7 tasks

dmvt opened this issue May 20, 2020 · 0 comments

Open

1 of 7 tasks

[Documentation] JSDoc documentation for all functions #2

dmvt opened this issue May 20, 2020 · 0 comments

Labels

Contributor

dmvt commented May 20, 2020

User Story

As an <audience/user>: dev
I want to <action/task>: be able to read concise documentation of what each function does
so that <outcome/goal/benefit>: so I don't have to read the code to know what's happening

Type

Enhancement
Maintenance
Refactor

Description

https://en.wikipedia.org/wiki/JSDoc

Definition of Done

Attach files or screenshots if it's helpful for this issue.

dmvt added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment