akka/akka-core

Stream operators docs gen: handle cases for <a name=""/> when the same name exists in more places

Open

#24,977 opened on Apr 24, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wantednice-to-have (low-prio)t:docs

Description

For example ask exists both on Flow and ActorFlow so we have to implement some disambiguation for the link names.

Most likely a simple class.opname would be enough

Contributor guide

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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ScalaAkka Streams
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the documentation generation code for stream operators, likely in the Akka doc generation plugin or SBT tasks. Investigate how anchor names are generated for methods like `ask` on `Flow` and `ActorFlow`. The suggested fix is to prefix the name with the class name, e.g., `Flow.ask` and `ActorFlow.ask`. Ensure the change does not break existing links.