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 (3,547 forks)batch import
1 - triagedhelp wantednice-to-have (low-prio)t:docs

Repository metrics

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

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

Research direction
Inspect the documentation generation code for stream operators and add disambiguation for anchor names when the same name exists in multiple classes, e.g., by prepending the class name.
Tech stack
scala
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60