akka/akka-core

Add Scala only operator mark in generated docs

Aberta

#28.422 aberto em 21 de dez. de 2019

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Scala (3.547 forks)batch import
help wantednice-to-have (low-prio)

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

If introduce flattenMerge or flattenConcat then both of them should live only In scaladsl; The current StreamOperatorsIndexGenerator extract information from source code. and expects both API lives in Flow.scala shows up in Java and Scala DSL. I think a nicer way is to leverage the language features and add a special mark to the generated index page.

image

Guia do colaborador

Direção de pesquisa
Examine o código fonte do StreamOperatorsIndexGenerator para entender como a documentação do operador é gerada, em seguida, implemente um mecanismo para marcar operadores apenas Scala (por exemplo, com uma anotação ou flag) e atualize o gerador de índice para renderizar essa marca.
Pilha de tecnologia
scala
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
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
ScalaAkka
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50