Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation needs better examples

See original GitHub issue

Consider this example for 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:open
  • Created 5 years ago
  • Reactions:11
  • Comments:23 (5 by maintainers)

github_iconTop GitHub Comments

aearlycommented, Jan 15, 2019

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.

flatcodingcommented, Aug 26, 2019

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.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found