downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open

#1,057 opened on 2020年5月20日

GitHub で見る
 (2 comments) (3 reactions) (0 assignees)JavaScript (11,761 stars) (980 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.