akka/akka-core

Additional stream operators to include in overview

開放

#25,467 建立於 2018年8月13日

 (7 則留言) (0 個反應) (0 位負責人)Scala (3,547 個分叉)batch import
1 - triagedgood first issuehackathonhelp wantedt:docst:stream

倉庫指標

星標
 (13,277 顆星)
PR 合併指標
 (平均合併 8天 19小時) (30 天內合併 10 個 PR)

描述

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

貢獻者指南