downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open

#1057 opened on May 20, 2020

View on GitHub
 (2 comments) (3 reactions) (0 assignees)JavaScript (11,761 stars) (980 forks)batch import
chorehelp wanted

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

Contributor guide

Tech stack
javascripttypescriptreact
Domain
developer experiencedocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptJSDocFamiliarity with downshift API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.