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 (980 forks)batch import
chorehelp wanted

Métriques du dépôt

Stars
 (11 761 stars)
Métriques de merge PR
 (Merge moyen 6j 9h) (5 PRs mergées en 30 j)

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

Direction de recherche
Ajoutez des commentaires JSDoc à chaque prop dans index.d.ts en extrayant les descriptions du README ou des commentaires du code source.
Stack technique
typescriptjavascriptreact
Domaine
frontend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScriptJSDoc
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90