akka/akka-core

Better documentation of event stream semantics

Open

#26,854 opened on May 2, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantedt:coret:typed

Repository metrics

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

Description

Follow up after #26810, The scaladoc of the untyped event stream does not mention what happens if you subscribe several times, unsubscribe something that wasn't subscribed etc. Would be good to add that to both the untyped API and the corresponding typed messages.

Contributor guide

Research direction
Study the existing scaladoc for untyped event streams and typed messages in Akka. Understand the subscription semantics (multiple subscriptions, unsubscribing non existent subscriptions) and add clear documentation to both APIs.
Tech stack
scala
Domain
backend
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
ScalaAkka
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70