typelevel/cats

Add a documentation page on error handling

Open

#3,523 opened on Jul 16, 2020

View on GitHub
 (8 comments) (3 reactions) (0 assignees)Scala (5,438 stars) (1,241 forks)batch import
documentationhelp wanted

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

Contributor guide

Tech stack
scala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Scala basicsCats library familiarityUnderstanding of MonadError
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the existing Cats documentation structure, particularly the error handling section. Look at issue #1801 for related discussions. Examine the source files for ApplicativeError and MonadError to understand the concepts. Determine where to add the new page and ensure consistency with existing documentation style.