akka/akka-core

Scalafix followups: Move doc specs to doc/jdoc package

Aberta

#26.045 aberto em 5 de dez. de 2018

Ver no GitHubGuia do colaborador
 (6 comentários) (0 reação) (0 responsável)Scala (3.547 forks)batch import
1 - triagedhelp wantedt:docs

Métricas do repositório

Stars
 (13.277 estrelas)
Métricas de merge de PR
 (Mesclagem média 8d 19h) (10 fundiu PRs em 30d)

Description

https://github.com/akka/akka/pull/26019#pullrequestreview-181636601 introduced scalafix to remove unused imports. It is not enabled on compile and can remove imports that are included in specs for docs.

To followup:

  • Ignore files in doc/jdoc package
  • Move any doc specs to the doc for Scala and jdoc package so that imports are necessary e.g. FlowZipSpec is in the akka.stream.scaladsl and is used for docs. The unit test parts should remain but the docs part should be in a new file in the docs package do that imports from akka.stream.scaladsl are required
  • Test how fast it is to enable on compile and decide if we want it enabled by default

Guia do colaborador

Direção de pesquisa
Identifique as especificações de documentação em pacotes não doc (por exemplo, FlowZipSpec em akka.stream.scaladsl) e mova as para o pacote doc/jdoc apropriado, garantindo que as importações do pacote principal sejam necessárias. Siga o padrão da PR vinculada.
Pilha de tecnologia
scala
Domain
backend
Tipo Issue
Refatoraçã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.
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
GitScala
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65