caolan / caolan/async

Documentation needs better examples

Open
#1,609 23 comments 11 reactions 0 assignees View on GitHub
docs help wanted
Dominant language
JavaScript
Stars
28.1k
Forks
2.4k
PR merge metrics
No merged PRs in 30d

Description

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

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.