caolan/async

Documentation needs better examples

Open

#1,609 opened on 2019年1月13日

GitHub で見る
 (23 comments) (11 reactions) (0 assignees)JavaScript (28,067 stars) (2,398 forks)batch import
docshelp wanted

説明

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

コントリビューターガイド

技術スタック
javascript
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
active
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
basic knowledge of async.jsunderstanding of callbacks
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
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).