caolan/async

Documentation needs better examples

Open

#1.609 aberto em 13 de jan. de 2019

Ver no GitHub
 (23 comments) (11 reactions) (0 assignees)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

Guia do colaborador

Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
active
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
basic knowledge of async.jsunderstanding of callbacks
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
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).