caolan/async

Documentation needs better examples

Open

#1.609 geöffnet am 13. Jan. 2019

Auf GitHub ansehen
 (23 Kommentare) (11 Reaktionen) (0 zugewiesene Personen)JavaScript (2.398 Forks)batch import
docshelp wanted

Repository-Metriken

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

Beschreibung

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

Contributor Guide