manrajgrover/algorithms-js

Fix JSDocs strings

Open

#22 aperta il 1 ago 2017

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)JavaScript (132 fork)github user discovery
documentationenhancementgood first issuehacktoberfest

Metriche repository

Star
 (200 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Since auto documentation generation depends on JS DocStrings, there is need to fix and provide as much information possible.

Reference: http://usejsdoc.org/index.html

Guida contributor

Direzione di ricerca
Rivedi i commenti JSDoc esistenti nel codebase e aggiornali per seguire lo standard JSDoc (usejsdoc.org). Assicurati che funzioni, parametri e tipi di ritorno siano correttamente documentati.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
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
JavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90