mobxjs/mobx.dart

Update API docs to be more exhaustive

Open

#249 aberto em 17 de ago. de 2019

Ver no GitHub
 (1 comment) (4 reactions) (0 assignees)Dart (303 forks)batch import
docsgood first issuehelp wanted

Métricas do repositório

Stars
 (2.300 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

The API docs for reactions do not show the various options available for autorun, reaction, when, asynWhen. This needs to be added.

Guia do colaborador

Direção de pesquisa
Examine os arquivos de documentação da API existentes no repositório mobx.dart, provavelmente em uma pasta 'docs' ou inline no código fonte. Veja como outras funções como `computed` ou `observable` documentam suas opções. Em seguida, para cada uma de `autorun`, `reaction`, `when` e `asyncWhen`, identifique as opções disponíveis (por exemplo, `name`, `delay`, `onError`) a partir do código fonte (por exemplo, em `lib/src/`). Adicione documentação abrangente para essas opções seguindo o estilo existente. A issue é clara, mas está inativa; não há PRs ou comentários vinculados a considerar.
Pilha de tecnologia
dartflutter
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.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
familiarity with MobXDart documentation practicesreading source code
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75