mobxjs/mobx.dart

Update API docs to be more exhaustive

Open

#249 ouverte le 17 août 2019

Voir sur GitHub
 (1 commentaire) (4 réactions) (0 assignés)Dart (303 forks)batch import
docsgood first issuehelp wanted

Métriques du dépôt

Stars
 (2 300 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez les fichiers de documentation d'API existants dans le dépôt mobx.dart, probablement dans un dossier 'docs' ou en ligne dans le code source. Regardez comment d'autres fonctions comme `computed` ou `observable` documentent leurs options. Ensuite, pour chacune des fonctions `autorun`, `reaction`, `when` et `asyncWhen`, identifiez les options disponibles (par exemple `name`, `delay`, `onError`) à partir du code source (par exemple dans `lib/src/`). Ajoutez une documentation complète pour ces options en suivant le style existant. L'issue est claire mais ancienne ; aucun PR ou commentaire lié n'est à prendre en compte.
Stack technique
dartflutter
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
familiarity with MobXDart documentation practicesreading source code
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75