caolan/async

Documentation needs better examples

Open

#1 609 ouverte le 13 janv. 2019

Voir sur GitHub
 (23 commentaires) (11 réactions) (0 assignés)JavaScript (28 067 stars) (2 398 forks)batch import
docshelp wanted

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

Guide contributeur

Stack technique
javascript
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
basic knowledge of async.jsunderstanding of callbacks
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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).