typelevel/cats

Improve doc for Func

Open

#2.650 aberto em 30 de nov. de 2018

Ver no GitHub
 (8 comments) (0 reactions) (1 assignee)Scala (1.241 forks)batch import
documentationgood first issuehelp wantedlow-hanging fruitscope: small

Métricas do repositório

Stars
 (5.438 stars)
Métricas de merge de PR
 (Mesclagem média 4h 2m) (5 fundiu PRs em 30d)

Description

Nobody knows what the hell Func does ... linking to a 25-page Haskell paper (even a good one) isn't ideal. Can we improve the doc, at least to the point of explaining why we need both Func and Kleisli and how you might use it?

There is some discussion here.

Guia do colaborador

Direção de pesquisa
Escreva uma documentação clara explicando o propósito de Func, sua relação com Kleisli e inclua exemplos de uso. Consulte a discussão vinculada para obter contexto.
Pilha de tecnologia
None
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.
1
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
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90