akka/akka-core

Add Scala only operator mark in generated docs

Open

#28,422 opened on Dec 21, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
help wantednice-to-have (low-prio)

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Examine the StreamOperatorsIndexGenerator source to understand how operator documentation is generated, then implement a mechanism to mark operators as Scala only (e.g., with an annotation or flag) and update the index generator to render that mark.
Tech stack
scala
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaAkka
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50