downshift-js/downshift

JSDoc comments in typings to enhance usability of props

Open

#1057 aperta il 20 mag 2020

Vedi su GitHub
 (2 commenti) (3 reazioni) (0 assegnatari)JavaScript (980 fork)batch import
chorehelp wanted

Metriche repository

Star
 (11.761 star)
Metriche merge PR
 (Merge medio 4g 9h) (7 PR mergiate in 30 g)

Descrizione

  • 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

Guida contributor

Direzione di ricerca
Apri il file index.d.ts nel repository. Per ogni proprietà definita nelle definizioni dei tipi, individua la descrizione corrispondente nei file README.md (ad esempio, docs/). Quindi aggiungi commenti JSDoc /** ... */ sopra ogni proprietà con la descrizione. Assicurati che i commenti siano formattati correttamente per essere riconosciuti da TypeScript e dagli IDE. Non ci sono blocchi o PR collegati.
Tech stack
javascripttypescriptreact
Dominio
developer experiencedocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptJSDocFamiliarity with downshift API
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85