downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open

#1 057 ouverte le 20 mai 2020

Voir sur GitHub
 (2 commentaires) (3 réactions) (0 assignés)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

Guide contributeur

Stack technique
javascripttypescriptreact
Domaine
developer experiencedocumentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
TypeScriptJSDocFamiliarity with downshift API
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
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.