akka/akka-http

ExceptionHandlerExamplesSpec in docs cannot be copy / pasted

Open

#3,971 创建于 2021年12月14日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Scala (1,311 star) (598 fork)batch import
1 - triagedhelp wantedt:docs

描述

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

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Scalaakka http
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
The issue is that the example in `docs/src/test/scala/docs/http/scaladsl/server/ExceptionHandlerExamplesSpec.scala` does not compile because `myExceptionHandler` is defined as a top level entity instead of inside `MyApp`. The fix should follow the pattern from a previous PR (referenced in the issue) to wrap the snippet in a class. Examine the referenced PR and the file to understand the required structure.