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 (28.067 Stars) (2.398 Forks)batch import
docshelp wanted

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

Tech Stack
javascript
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
active
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
basic knowledge of async.jsunderstanding of callbacks
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
Review all existing documentation examples in the README and source files. Identify the most common use cases for each function (map, filter, each, etc.) and replace simplistic examples like fs.stat with realistic scenarios such as fetching user data or processing API responses. Ensure each example demonstrates the function's options (e.g., concurrency, error handling). Check the issue comments for specific suggestions and link to the relevant files (e.g., docs/index.md).