akka/akka-http

ExceptionHandlerExamplesSpec in docs cannot be copy / pasted

Aperta

#3971 aperta il 14 dic 2021

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Scala (598 fork)batch import
1 - triagedhelp wantedt:docs

Metriche repository

Star
 (1311 stelle)
Metriche merge PR
 (Merge medio 1g 10h) (2 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Sposta la definizione di 'myExceptionHandler' all'interno di un oggetto come 'MyApp' per garantire che compili correttamente. Assicurati che l'esempio sia autonomo e copiabile.
Tech stack
scala
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ScalaGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70