typelevel/cats

Add a documentation page on error handling

Ouverte

#3 523 ouverte le 16 juil. 2020

Voir sur GitHubGuide contributeur
 (8 commentaires) (3 réactions) (0 personne assignée)Scala (1 241 forks)batch import
documentationhelp wanted

Métriques du dépôt

Stars
 (5 438 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez la structure de documentation existante pour Cats, comprenez les concepts de MonadError et ApplicativeError à partir du code source et de la documentation existante, et ajoutez une nouvelle page avec des modèles courants de gestion des erreurs.
Stack technique
scala
Domaine
documentation
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.
Une demi journée
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
Scala
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80