caolan/async

Documentation needs better examples

Open

#1609 aperta il 13 gen 2019

Vedi su GitHub
 (23 commenti) (11 reazioni) (0 assegnatari)JavaScript (2398 fork)batch import
docshelp wanted

Metriche repository

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

Descrizione

Consider this example for map

async.map(['file1','file2','file3'], fs.stat, function(err, results) {
    // results is now an array of stats for each file
});

This basically tells me nothing except syntax. In most cases people aren't going to pass fs.stat. The examples should include use of all possible options. All examples for all functions and methods need to be updated. They are too simplistic

Guida contributor