akka / akka/akka-http

document that HTTP route construction must not close over Actor state

Open
#110 1 comment 0 reactions 0 assignees View on GitHub
1 - triaged help wanted small t:docs
Dominant language
Scala
Stars
1.4k
Forks
584
Avg merge
14h 33m
Merged PRs (30d)
24

Description

**Issue by [rkuhn](https://github.com/rkuhn)**
_Thursday Feb 12, 2015 at 20:01 GMT_
_Originally opened as https://github.com/akka/akka/issues/16871_

---

The pattern we show should be inspired by the Props recommendation: build the Route in a function within the companion object to make sure that nothing is pulled in accidentally, all captured values are explicit.

Contributor guide

Open the contributing guide

Research direction

Locate the HTTP route construction examples and the existing Props recommendation in the documentation. Document the companion-object pattern, making clear that route construction must not close over Actor state and that captured values should be explicit. Done means the guidance is present alongside the relevant route example.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.