akka/akka-core

Additional stream operators to include in overview

Aberta

#25.467 aberto em 13 de ago. de 2018

Ver no GitHubGuia do colaborador
 (7 comentários) (0 reação) (0 responsável)Scala (3.547 forks)batch import
1 - triagedgood first issuehackathonhelp wantedt:docst:stream

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

There are a number of stream operators not yet documented at https://doc.akka.io/docs/akka/current/stream/operators/index.html .

The most current list of not-yet-documented operators can be found at https://github.com/akka/akka/blob/master/project/StreamOperatorsIndexGenerator.scala#L78 . Some probably can remain undocumented, those should be moved to the 'ignore list at https://github.com/akka/akka/blob/master/project/StreamOperatorsIndexGenerator.scala#L121

To document an operator:

  • Optionally, add a comment to this issue 'claiming' the operator
  • Remove it from the 'pending' list
  • Add the markdown file to /akka-docs/src/main/paradox/stream/operators. The convention is Classname/operatorname.md, with the exception of operators that are available on both Sources and Flows. Look at the other files for examples.
  • run sbt paradox to test generating the documentation

Guia do colaborador

Direção de pesquisa
Examine os operadores já documentados no diretório /akka docs/src/main/paradox/stream/operators como exemplos. Em seguida, selecione um operador não documentado da lista pendente em project/StreamOperatorsIndexGenerator.scala e siga as etapas para adicionar um arquivo markdown.
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.
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
ScalaGitsbt
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75