typelevel/cats

Add a documentation page on error handling

Open

#3,523 创建于 2020年7月16日

在 GitHub 查看
 (8 评论) (3 反应) (0 负责人)Scala (5,438 star) (1,241 fork)batch import
documentationhelp wanted

描述

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

贡献者指南

技术栈
scala
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Scala basicsCats library familiarityUnderstanding of MonadError
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
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.