finagle/finch

Scaladoc hygiene for base package

Aperta

#411 aperta il 12 ott 2015

Vedi su GitHubGuida contributor
 (6 commenti) (0 reazioni) (0 assegnatari)Scala (218 fork)batch import
cleanupeasyhelp wanted

Metriche repository

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

Descrizione

As more stuff gets moved directly under io.finch, its API docs are getting a little unwieldy. It'd be nice to make prioritization traits private[finch] so they don't show up in the docs (their methods still will, though), and possibly even to organize the definitions using Scaladoc groups (see e.g. how I'm using them in circe).

Guida contributor

Direzione di ricerca
Identifica i tratti di prioritizzazione nel pacchetto base e modifica la loro visibilità in private[finch] in modo che siano esclusi dalla Scaladoc. Poi esplora l'uso dei gruppi Scaladoc per organizzare le definizioni, simile agli esempi nella libreria circe.
Tech stack
scala
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ScalaScaladoc
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70