typelevel/cats

Add a documentation page on error handling

Offen

#3.523 geöffnet am 16.07.2020

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)Scala (1.241 Forks)batch import
documentationhelp wanted

Repository-Metriken

Stars
 (5.438 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfe die bestehende Dokumentationsstruktur für Cats, verstehe die Konzepte von MonadError und ApplicativeError aus dem Quellcode und der vorhandenen Dokumentation und füge eine neue Seite mit gängigen Fehlerbehandlungsmustern hinzu.
Tech Stack
scala
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Scala
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80