downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open

#1,057 建立於 2020年5月20日

在 GitHub 查看
 (2 留言) (3 反應) (0 負責人)JavaScript (11,761 star) (980 fork)batch import
chorehelp wanted

描述

  • downshift version: 5.4.0

Problem description:

Currently, all descriptions of props are found through Github. They are nice and all, but it is a hassle to access the repo every time I need to read further up on the props.

Suggested solution:

Add all descriptions to index.d.ts from the README's in a JSDoc-like format (e.g. typedoc), thus having the descriptions readily available through your IDE/editor of choice

Here is an example of what it may look like in VSCode when a line was added. image

貢獻者指南

技術棧
javascripttypescriptreact
領域
developer experiencedocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
TypeScriptJSDocFamiliarity with downshift API
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Open the index.d.ts file in the repository. For each prop defined in the type definitions, locate the corresponding description in the README.md files (e.g., docs/). Then add /** ... */ JSDoc comments above each prop with the description. Ensure the comments are formatted correctly to be picked up by TypeScript and IDEs. There are no blockers or linked PRs.