josephg/node-foundationdb

Port documentation into typescript doc comments

Aperta

#26 aperta il 15 mar 2019

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (20 fork)github user discovery
enhancementgood first issuehelp wanted

Metriche repository

Star
 (129 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

There's lots of transaction & database methods which are missing documentation comments.

We should do a pass adding typescript tsdoc - compatible doc comments for all the normal function in (at a minimum) lib/transaction.ts and lib/database.ts.

This documentation is picked up by documentation tools and by editors (like vs code), which makes it very handy while using the API.

Guida contributor

Direzione di ricerca
Esamina i file TypeScript esistenti (lib/transaction.ts, lib/database.ts) e aggiungi commenti di documentazione compatibili con TSDoc a tutte le funzioni e i metodi pubblici, seguendo le convenzioni utilizzate altrove nel codice.
Tech stack
typescript
Dominio
apibackend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85