question-mark
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.

Further Doc improvements

See original GitHub issue

From @deltaidea on #254:

  • @tjvr: Document save() / restore()
  • Performance tips: avoiding ambiguity, using moo. (#81, #238, #243, #250)
  • Debugging tips: inspecting that the right tokens are parsed, using nearley-test. (#253)
  • Error handling:
    • List of possible exceptions. I imagine it’s short, but I’m not sure about it myself.
    • Empty parser.results. (#253)
  • IDE support: syntax highlighting is supported at least in VS Code, probably in other editors too.
  • Go through the source code and update references to the readme.
  • @hardmath123: Introduction should also describe why people like nearley: it’s user-friendly, easy to get started, works on both the browser and node, etc.
  • @hardmath123: I think “parse complex data structures” is not quite what we wanted to say, even in the original README. This is a good opportunity to find better wording. Complex languages, perhaps?

Issue Analytics

  • State:open
  • Created 6 years ago
  • Comments:13 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
tjvrcommented, Oct 26, 2018

@diegoperini You should absolutely be able to use save() and restore() with Moo.

1reaction
diegoperinicommented, Oct 23, 2018

It’s good enough. Thank you so much. Maybe after I get a grasp of it, I can write the docs for you as my thanks.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How do I document improvement?
Improve or optimize the current process using data analysis techniques such as design of experiments, poka yoke or mistake proofing (engineering ...
Read more >
Documenting and Sharing Improvements and Lessons ...
As improvement is continuous, having documented the previous improvements and trained our team, it makes it easier to improve another step when our...
Read more >
13 features to improve your Google Docs experience
These handy-but-hidden features will help you do things like create typing shortcuts, translate text instantly, or add GIFs to your ...
Read more >
Six Tips for Improving Your Design Documentation
Good organization, complete information, and clear writing are, of course, key to the success of any design document, but there are some other, ......
Read more >
Doc Improvements
Clarify that programs purge unused variables and suggest ways to handle this. Added by einarf. From To ...
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 Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found