nisrulz/sensey

[Question] Enhancement of Javadocs

Aperta

#11 aperta il 29 giu 2016

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Kotlin (267 fork)github user discovery
enhancementhelp wanted

Metriche repository

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

Descrizione

Hi. Recently I saw your update and you added javadocs, and I think for library project it's awesome. But may be it should be written more info than simple, for example, "Creates new Flip Detector", because when you write new FlipDetection(something) you already now, that you creating new Detector. I think it would be great if javadocs contained more specific info about, why we need, for example, such detector and e.t.c. What do you think about this idea?

Guida contributor

Direzione di ricerca
Rivedi i Javadoc attuali nel repository e identifica metodi come 'new FlipDetection' che mancano di spiegazioni dettagliate. Suggerisci di aggiungere contesto sul perché ogni rivelatore viene utilizzato e il suo comportamento.
Tech stack
kotlinandroid
Dominio
mobiledocumentation
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
JavaKotlin
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90