Documentation needs better examples
See original GitHub issueConsider 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
Issue Analytics
- State:
- Created 5 years ago
- Reactions:11
- Comments:23 (5 by maintainers)
Top Results From Across the Web
12 Best Documentation Examples - HeroThemes
Some examples of project documentation include project proposals, project plans, business cases, status reports, and so on.
Read more >5 Tips for Improving Documentation | CloudApp Blog
Learn how to improve documentation at your company with these five simple tips. ... There are plenty more examples we could give, but...
Read more >Importance of Documentation | The Workstream - Atlassian
Documentation encourages knowledge sharing, which empowers your team to understand how processes work and what finished projects typically look like.
Read more >8 Great Examples of Developer Documentation - Zapier
Good documentation allows feedback from readers so they can point out inconsistencies or typos and have them addressed quickly. Even better is ...
Read more >How to Write a Good Documentation: Home
Best Practices for Documenting Your Project · Include a README file that contains · Allow issue tracker for others · Write an API...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I agree, we need much better docs. I’d also like to change many of the examples (or add mroe examples) to use async/await. However, this is something that takes time I don’t have at the moment.
I’m in particular looking for a (simple) Promise-based example of async.mapLimit, even without async/await. Haven’t found any non-callback example so far at all.