codeforboston / codeforboston/cliff-effects
Make JSDoc comments more useful
Open
infrastructure
ongoing
- Dominant language
- JavaScript
- Stars
- 30
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
Currently, there are several places in the (now publishable) JSDoc comments where:
* Things are missing (or "TODO")
* Things that shouldn't be documented (minor local variables) are documented
* A comment refers to the wrong entity
* There are (apparently) several entries on the same object, or objects with the same name
Let's clean these up so that the docs make sense!
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.