downshift-js/downshift

JSDoc comments in typings to enhance usability of props

オープン

#1,057 opened on 2020/05/20

 (2 件のコメント) (3 件のリアクション) (0 人の担当者)JavaScript (980 件のフォーク)batch import
chorehelp wanted

Repository metrics

Stars
 (11,761 個のスター)
PR merge metrics
 (PR metrics pending)

説明

  • 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

コントリビューターガイド