akka/akka-http

ExceptionHandlerExamplesSpec in docs cannot be copy / pasted

Open

#3,971 opened on Dec 14, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

Some examples are broken again.

The example doesn't compile. The problem that was addressed in this PR needs to be addressed again in the same way. Essentially myExceptionHandler cannot be a top-level entity with respect to a file (in Scala 2), it should be in MyApp. The specification compiles because this snippet is itself in MyExplicitExceptionHandler, but a user looking at the documentation is unlikely to figure that out.

Originally posted by @FlorianCassayre in https://github.com/akka/akka-http/issues/1465#issuecomment-993396956

Contributor guide

Research direction
Move the 'myExceptionHandler' definition inside an object like 'MyApp' to ensure it compiles correctly. Ensure the example is self contained and copy pastable.
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.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70