akka/akka-core

Additional stream operators to include in overview

Aperta

#25.467 aperta il 13 ago 2018

Vedi su GitHubGuida contributor
 (7 commenti) (0 reazioni) (0 assegnatari)Scala (3547 fork)batch import
1 - triagedgood first issuehackathonhelp wantedt:docst:stream

Metriche repository

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

Descrizione

There are a number of stream operators not yet documented at https://doc.akka.io/docs/akka/current/stream/operators/index.html .

The most current list of not-yet-documented operators can be found at https://github.com/akka/akka/blob/master/project/StreamOperatorsIndexGenerator.scala#L78 . Some probably can remain undocumented, those should be moved to the 'ignore list at https://github.com/akka/akka/blob/master/project/StreamOperatorsIndexGenerator.scala#L121

To document an operator:

  • Optionally, add a comment to this issue 'claiming' the operator
  • Remove it from the 'pending' list
  • Add the markdown file to /akka-docs/src/main/paradox/stream/operators. The convention is Classname/operatorname.md, with the exception of operators that are available on both Sources and Flows. Look at the other files for examples.
  • run sbt paradox to test generating the documentation

Guida contributor

Direzione di ricerca
Esamina gli operatori già documentati nella directory /akka docs/src/main/paradox/stream/operators come esempio. Quindi seleziona un operatore non documentato dall'elenco in sospeso in project/StreamOperatorsIndexGenerator.scala e segui i passaggi per aggiungere un file markdown.
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.
1-3 ore
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
ScalaGitsbt
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75