cheminfo / cheminfo/multiplet-analysis
Add jsdoc
Open
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
A lot of function does not have jsdoc. Would be nice to add it explaining all the parameters.
Because currently vscode use the jsdoc to know if an option is allowed it leads to many errors.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by surveying the TypeScript source for functions without JSDoc and identify the option parameters that currently produce VS Code errors. Add parameter documentation across the affected functions, then verify that VS Code no longer reports those options as invalid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100