akka/akka-core

Rewrite Future docs, they miss to show best practices and traps

Aberta

#23.948 aberto em 9 de nov. de 2017

Ver no GitHubGuia do colaborador
 (2 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

Current Future docs are rather ancient and focused on showing off the Future API, and Await actually. I think we're in real need of rewriting these two pages:

Guia do colaborador

Direção de pesquisa
Revise a documentação atual do Future nos URLs fornecidos, identifique as melhores práticas faltantes (por exemplo, pipeTo, evitar mutações de estado mutável) e armadilhas comuns, e reescreva ambas as páginas com exemplos completos e avisos.
Pilha de tecnologia
None
Domain
documentation
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.
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
GitAkka
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70