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 (3,547 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

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

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

Research direction
Review the current Future docs at the provided URLs, identify missing best practices (e.g., pipeTo, avoiding mutable state mutations) and common traps, then rewrite both pages with complete examples and warnings.
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.
Half day
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
GitAkka
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70