manrajgrover / manrajgrover/algorithms-js
Fix JSDocs strings
Open
Nobody has claimed this yet.
documentation
enhancement
good first issue
hacktoberfest
- Dominant language
- JavaScript
- Stars
- 200
- Forks
- 136
- PR merge metrics
- No merged PRs in 30d
Description
Since auto documentation generation depends on JS DocStrings, there is need to fix and provide as much information possible.
Reference: http://usejsdoc.org/index.html
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
No source files or tests are identified in the issue. Start by locating the JavaScript source comments used by the automatic documentation generator, then compare their JSDoc with the linked JSDoc reference; done means the relevant documentation strings provide complete, useful information for generation.
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
- 25/100