Cloud-CV / Cloud-CV/Origami

Using JSDocs for inline docs

Open
#279 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
172
Forks
109
PR merge metrics
No merged PRs in 30d

Description

Thanks for taking the time to report a bug in the Origami project, or propose a new feature! Before creating a new issue, please do a quick search to check that it hasn't already been filed on the [issue tracker](https://github.com/Cloud-CV/Origami/issues).
For more information, see the [CONTRIBUTING Guide](https://github.com/Cloud-CV/Origami/blob/master/.github/CONTRIBUTING.md)

## Description
It kind of imitates typescript functionality by describing function return types, param types etc. I know it's been done using proptypes, but JSDocs provides more extensive functionality and helps understanding the codebase for beginners and also maintaing documentation.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.