ladybug-tools / ladybug-tools/spider-core
Review JSDoc
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
I have added some documentation comments to the code here which gets deployed to gh-pages. It would be great if the blanks in my understanding of the different functions and classes could be filled in. Is this something you could have a look at @theo-armour? Here's a link to JSdoc documentation if you haven't used it before.
Contributor guide
No contributing guide indexed for this repository
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
Review the existing documentation comments in the codebase, using the linked JSDoc ES2015 classes guide as a reference. Compare the source comments with the documentation deployed to gh-pages and identify missing explanations for functions and classes. Done means the gaps in the JSDoc coverage are filled and the deployed pages reflect the improved comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100