akka/akka-core

Docs incorrectly state that SupervisorStrategy can't be changed

Open

#20,755 opened on Jun 8, 2016

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wantedt:coret:docs

Description

In the chapter about Fault Tolerance: "... each actor is the supervisor of its children, and as such each actor defines fault handling supervisor strategy. This strategy cannot be changed afterwards ..."

Looking at the ultimate source of truth – the code – I strongly doubt this is correct: Actor.supervisorStrategy is a method and from what I could see it is used "directly" (as opposed to receive).

Contributor guide

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.
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.
mostly clear
Prerequisites
Basic Akka knowledgeScala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue points out that the documentation in the Fault Tolerance chapter states that the supervisor strategy cannot be changed, but the user suspects it can based on the method `Actor.supervisorStrategy`. To verify, look at the source code in `Actor.scala` to see how `supervisorStrategy` is defined and used. Then, update the documentation (likely in the Fault Tolerance chapter) to reflect the correct behavior. Check for any existing discussions or PRs that may clarify the intended behavior.
Docs incorrectly state that SupervisorStrategy can't be changed · akka/akka-core#20755 | Good First Issue