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 合并指标
 (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

贡献者指南