caolan/async

Documentation needs better examples

Open

#1,609 opened on Jan 13, 2019

View on GitHub
 (23 comments) (11 reactions) (0 assignees)JavaScript (2,398 forks)batch import
docshelp wanted

Repository metrics

Stars
 (28,067 stars)
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

Research direction
Review the current documentation for each function, identify common use cases, and add comprehensive examples that demonstrate all available options. Start with the most commonly used functions like 'map', 'each', 'waterfall'.
Tech stack
javascript
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70