facebook/flow

Improce docs & examples for interfaces, modules, classes, etc.

Open

Aperta il 7 apr 2017

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Rust (22.203 star) (1885 fork)batch import
Accepting PRshelp wanted

Descrizione

hi, I find it very hard to move into imports, exports, declares, modules, successfully with flow, I have failed so far. And reading other issues has made it appear to me that other (even smart) people have been tripped up by all this random example: https://github.com/facebook/flow/issues/769. Thus I would like to suggest that somebody who really groks this stuff does some pair documenting with somebody who doesn't, to work up some succinct but fully fleshed out examples.

Guida contributor

Tech stack
javascript
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Basic knowledge of JavaScriptFamiliarity with Flow type system
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65
Direzione di ricerca
The issue requests improved documentation and examples for Flow's interfaces, modules, classes, and related concepts. The body references issue #769, which may contain additional context. Maintainers should identify specific gaps in the current documentation, possibly by reviewing existing docs and examples. Then create concise, step by step examples covering imports, exports, declares, and modules. The work should be coordinated with maintainers to ensure accuracy.