downshift-js / downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open
#1,057 2 comments 3 reactions 0 assignees View on GitHub
chore help wanted
Dominant language
JavaScript
Stars
12.3k
Forks
936
PR merge metrics
No merged PRs in 30d

Description

- `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](https://user-images.githubusercontent.com/10811383/82419956-61c44c00-9a7f-11ea-9406-b975fe2dfa7e.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.