seangwright/typescript-functional-extensions

Docs: More Consistent JSDoc comments

Aperta

#1 aperta il 27 dic 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (6 fork)auto 404
documentationgood first issuehelp wanted

Metriche repository

Star
 (39 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The language describing methods/parameters/return types isn't very consistent across the library.

We need to decide on a few things and then clean it all up:

  • Past/present tense
  • Verbose vs terse method description
    • Details in description or param/return type annotations
  • Comments just for method overload signatures or also for implementation
  • Comments on utility types

Guida contributor

Direzione di ricerca
Esamina i commenti JSDoc esistenti nel codice, identifica le incongruenze e proponi una guida di stile per i commenti JSDoc.
Tech stack
typescript
Dominio
Nessuno
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
typescript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90