akka/akka-core

TestFSMRef API example invalid

Open

#15,668 opened on Aug 14, 2014

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wantedt:docst:testing

Description

TestFSMRef API documentation is incorrect -- the TestFSMRef creation is missing a closing parenthesis, it uses the Ev() method which was removed in 2.0, it lacks the declaration of an ActorSystem, lacks a value for akka.util.Timeout, and possibly additional issues.

The documentation on Testing (3.9) suffers from similar, but worse, issues (imports are often omitted, as well as declarations of the test classes). And there's no documentation on how to use both TestKit and TestActorRef or TestFSMRef at the same time, or if it's even possible.

The use of Ev() is also present in other sections of the API, such as FSM.

Contributor guide

Tech stack
None
Domain
testingdocumentation
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.
half day
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
Familiarity with Akka actorsBasic understanding of FSMScalaTest testing framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Locate the TestFSMRef documentation file in the akka core source tree, likely under doc/ or akka testkit/. Verify the API usage for missing parenthesis, Ev() removal, and ActorSystem declaration. Also check the Testing section (3.9) for similar issues. Examine any existing comments or linked PRs for guidance on the correct format. Consider updating the documentation to reflect current Akka 2.x API.