1 - triagedgood first issuehackathonhelp wantedt:docst:stream
Repository metrics
- Stars
- (13,277 個のスター)
- PR merge metrics
- (平均マージ 8d 19h) (30d で 10 merged PRs)
説明
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 isClassname/operatorname.md, with the exception of operators that are available on bothSources andFlows. Look at the other files for examples. - run
sbt paradoxto test generating the documentation