akka/akka-core

Add Scala only operator mark in generated docs

Aperta

#28.422 aperta il 21 dic 2019

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Scala (3547 fork)batch import
help wantednice-to-have (low-prio)

Metriche repository

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

Descrizione

If introduce flattenMerge or flattenConcat then both of them should live only In scaladsl; The current StreamOperatorsIndexGenerator extract information from source code. and expects both API lives in Flow.scala shows up in Java and Scala DSL. I think a nicer way is to leverage the language features and add a special mark to the generated index page.

image

Guida contributor

Direzione di ricerca
Esamina il codice sorgente di StreamOperatorsIndexGenerator per capire come viene generata la documentazione degli operatori, quindi implementa un meccanismo per contrassegnare gli operatori solo Scala (ad esempio con un'annotazione o flag) e aggiorna il generatore di indice per visualizzare quel segno.
Tech stack
scala
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
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
ScalaAkka
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50