akka/akka-http

ExceptionHandlerExamplesSpec in docs cannot be copy / pasted

Open

#3 971 ouverte le 14 déc. 2021

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Métriques du dépôt

Stars
 (1 311 stars)
Métriques de merge PR
 (Merge moyen 1h 17m) (1 PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Déplacez la définition de 'myExceptionHandler' à l'intérieur d'un objet comme 'MyApp' pour garantir qu'il compile correctement. Assurez vous que l'exemple est autonome et copiable.
Stack technique
scala
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
ScalaGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70