typelevel/cats

Add a documentation page on error handling

Aperta

#3523 aperta il 16 lug 2020

Vedi su GitHubGuida contributor
 (8 commenti) (3 reazioni) (0 assegnatari)Scala (1241 fork)batch import
documentationhelp wanted

Metriche repository

Star
 (5438 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

There's some major gaps around error handling in the official docs, especially painful because the whole ecosystem relies on them - library users are often instructed to use MonadError/ApplicativeError error handling code, but it's not present in the documentation

  • Add a page on ApplicativeError/MonadError (one page, likely)
    • Either on that page or on its own page, provide a "cookbook" of common error handling examples

This is mentioned in #1801, but I thought it was worth calling out as its own issue

Guida contributor

Direzione di ricerca
Rivedi la struttura della documentazione esistente per Cats, comprendi i concetti di MonadError e ApplicativeError dal codice sorgente e dalla documentazione esistente, e aggiungi una nuova pagina con modelli comuni di gestione degli errori.
Tech stack
scala
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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
Scala
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80