mobxjs/mobx.dart

Update API docs to be more exhaustive

Open

#249 aperta il 17 ago 2019

Vedi su GitHub
 (1 commento) (4 reazioni) (0 assegnatari)Dart (303 fork)batch import
docsgood first issuehelp wanted

Metriche repository

Star
 (2300 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina i file di documentazione API esistenti nel repository mobx.dart, probabilmente in una cartella 'docs' o inline nel codice sorgente. Osserva come altre funzioni come `computed` o `observable` documentano le loro opzioni. Quindi, per ciascuna di `autorun`, `reaction`, `when` e `asyncWhen`, identifica le opzioni disponibili (ad esempio `name`, `delay`, `onError`) dal codice sorgente (ad esempio in `lib/src/`). Aggiungi una documentazione completa per queste opzioni seguendo lo stile esistente. L'issue è chiaro ma inattivo; non ci sono PR o commenti collegati da considerare.
Tech stack
dartflutter
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
familiarity with MobXDart documentation practicesreading source code
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75