downshift-js/downshift

JSDoc comments in typings to enhance usability of props

开放

#1,057 创建于 2020年5月20日

 (2 条评论) (3 个反应) (0 位负责人)JavaScript (980 个派生)batch import
chorehelp wanted

仓库指标

星标
 (11,761 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

  • 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

贡献者指南