typelevel/cats

Add a documentation page on error handling

Aberta

#3.523 aberto em 16 de jul. de 2020

Ver no GitHubGuia do colaborador
 (8 comentários) (3 reações) (0 responsável)Scala (1.241 forks)batch import
documentationhelp wanted

Métricas do repositório

Stars
 (5.438 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Revise a estrutura de documentação existente para Cats, entenda os conceitos de MonadError e ApplicativeError do código fonte e da documentação existente, e adicione uma nova página com padrões comuns de tratamento de erros.
Pilha de tecnologia
scala
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Scala
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80