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