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.
ExceptionHandlerExamplesSpec in docs cannot be copy / pasted · akka/akka-http#3971 | Good First Issue