Add docs files for `util.js` and `setTime.js`
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 48
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
Add a separate file that documents the functions available in:
- [ ] [`setTime.js`](https://github.com/mapbox/guidance-sim/blob/728e1476d741a367baf12f85cfc1eb856339b984/lib/setTime.js)
- [ ] [`util.js`](https://github.com/mapbox/guidance-sim/blob/728e1476d741a367baf12f85cfc1eb856339b984/lib/util.js)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading lib/setTime.js and lib/util.js, following the linked revisions in the issue. Identify the functions exported or available in each file and document them in separate documentation files. Done means both files have documentation covering their available functions; no tests are mentioned in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100