akka/akka-core

Rewrite Future docs, they miss to show best practices and traps

Aperta

#23.948 aperta il 9 nov 2017

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (0 assegnatari)Scala (3547 fork)batch import
1 - triagedhelp wantedt:docs

Metriche repository

Star
 (13.277 stelle)
Metriche merge PR
 (Merge medio 8g 19h) (10 PR mergiate in 30 g)

Descrizione

Current Future docs are rather ancient and focused on showing off the Future API, and Await actually. I think we're in real need of rewriting these two pages:

Guida contributor

Direzione di ricerca
Esamina la documentazione attuale di Future agli URL forniti, identifica le migliori pratiche mancanti (ad esempio pipeTo, evitare mutazioni di stato mutabile) e le trappole comuni, quindi riscrivi entrambe le pagine con esempi completi e avvertenze.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
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
GitAkka
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70