fluttercommunity / fluttercommunity/rx_command

Improve Readme and doc

Aperta
#54 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Dart
Stelle
136
Fork
22
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I really appreciate this package but I find the documentation difficult for newcomers:
- Various discrepancies in the name of the parameters between Readme, methods' signatures and Doc. For example these 3 names are used for the same parameter: `canExecute`, `restriction`, `registration`. I saw that this problem is mentioned in issue [#47 Nullability support](https://github.com/fluttercommunity/rx_command/issues/47#issuecomment-824623306) which cite another different name, `constraint`.
- The Readme seems to be aimed at those who already have some familiarity with this architecture, which is understandable; in the blog https://www.burkharts.net/apps/blog there are articles suitable for newcomers, but they are not up-to-date (for example, reference is made to the Observable of RxDart, which from version 0.23 directly uses the Stream). Not that this is a problem, I just guess that's why these guides weren't promoted more in the Readme.

I am inexperienced and unfamiliar with git but am available to help update the documentation. Personally, the guide that got me aficionado of this package was the blog article https://www.burkharts.net/apps/blog/rxvms-foundations-rxcommand-and-getit/, together with the two articles of the same series preceding it (which is much more complete than "Making Flutter more Reactive" mentioned in the Readme). One idea could be to update this series of articles to the current RxCommand and RxDart Api and make it available in the wiki of this repo.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia dal README del repository e confronta i nomi dei parametri con le firme dei metodi e la documentazione, quindi esamina l’issue #47 e la serie di articoli del blog collegata su RxCommand e RxDart. Chiarisci l’ambito della documentazione e scegli un insieme coerente di nomi; il lavoro è completato quando la guida per i nuovi contributori riflette l’API attuale e il materiale proposto per la wiki è aggiornato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
dart
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.