akka/akka-core

Rewrite Future docs, they miss to show best practices and traps

Open

#23,948 opened on Nov 9, 2017

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

Description

Current Future docs are rather ancient and focused on showing off the Future API, and Await actually. I think we're in real need of rewriting these two pages:

Contributor guide

Tech stack
None
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-2 days
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 Scala knowledgeUnderstanding of AkkaFamiliarity with Futures
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Rewrite the two linked documentation pages on Futures and JMM shared state. The pages need to emphasize best practices like using pipeTo instead of Await, and avoid pitfalls like mutating shared state from Futures. Review the existing comments for additional insights and ensure examples are complete and up to date.