typelevel/cats

Add doctests (excellent first-time issue)

Open

#2.479 aberto em 7 de set. de 2018

Ver no GitHub
 (14 comments) (0 reactions) (0 assignees)Scala (1.241 forks)batch import
documentationgood first issuehelp wanted

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

Doctests are a great way to provide compilable and testable example code for scaladoc. We should cover as many methods with doctests as possible. Here is an example of PR adding doctests. Note that to test the doctests run sbt coreJVM/test This issue encompasses the effort of adding more doctest coverage to our type classes and data types. It would be a great first-time contribution.

If you are interested, please comment here on what type classes or data types you'd like to work on.

Guia do colaborador

Direção de pesquisa
Escolha uma type class ou tipo de dados da biblioteca Cats, escreva doctests para seus métodos seguindo o PR de exemplo e execute `sbt coreJVM/test` para verificar.
Pilha de tecnologia
None
Domain
documentationtesting
Tipo Issue
Teste
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.
1-3 horas
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
Scalasbt
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85