manrajgrover/algorithms-js

Fix JSDocs strings

Open

#22 创建于 2017年8月1日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)JavaScript (132 fork)github user discovery
documentationenhancementgood first issuehacktoberfest

仓库指标

Star
 (200 star)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南

研究方向
审查代码库中现有的 JSDoc 注释，并根据 JSDoc 标准 (usejsdoc.org) 进行更新。确保函数、参数和返回类型有适当的文档。
技术栈
javascript
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
JavaScript
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90