mobxjs/mobx.dart

Update API docs to be more exhaustive

Open

#249 geöffnet am 17. Aug. 2019

Auf GitHub ansehen
 (1 Kommentar) (4 Reaktionen) (0 zugewiesene Personen)Dart (303 Forks)batch import
docsgood first issuehelp wanted

Repository-Metriken

Stars
 (2.300 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche die vorhandenen API Dokumentationsdateien im mobx.dart Repository, wahrscheinlich in einem 'docs' Ordner oder inline im Quellcode. Sieh dir an, wie andere Funktionen wie `computed` oder `observable` ihre Optionen dokumentieren. Identifiziere dann für jede der Funktionen `autorun`, `reaction`, `when` und `asyncWhen` die verfügbaren Optionen (z.B. `name`, `delay`, `onError`) aus dem Quellcode (z.B. in `lib/src/`). Füge umfassende Dokumentation für diese Optionen gemäß dem vorhandenen Stil hinzu. Das Issue ist klar, aber veraltet; es gibt keine verknüpften PRs oder Kommentare zu berücksichtigen.
Tech Stack
dartflutter
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
familiarity with MobXDart documentation practicesreading source code
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75