finagle/finch

Scaladoc hygiene for base package

Aberta

#411 aberto em 12 de out. de 2015

Ver no GitHubGuia do colaborador
 (6 comentários) (0 reação) (0 responsável)Scala (218 forks)batch import
cleanupeasyhelp wanted

Métricas do repositório

Stars
 (1.594 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

As more stuff gets moved directly under io.finch, its API docs are getting a little unwieldy. It'd be nice to make prioritization traits private[finch] so they don't show up in the docs (their methods still will, though), and possibly even to organize the definitions using Scaladoc groups (see e.g. how I'm using them in circe).

Guia do colaborador

Direção de pesquisa
Identifique os traits de priorização no pacote base e modifique sua visibilidade para private[finch] para que sejam excluídos da Scaladoc. Em seguida, explore o uso de grupos Scaladoc para organizar as definições, semelhante aos exemplos na biblioteca circe.
Pilha de tecnologia
scala
Domain
backend
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.
Menos de 1 hora
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
ScalaScaladoc
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70