-
Notifications
You must be signed in to change notification settings - Fork 326
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add an examples
folder with richer examples
#80
Comments
examples
folderexamples
folder with richer examples
I felt reading the test case code is a way of learning the examples, and they are guaranteed runnable 😄 |
Test cases are definitely good examples! As are example tests. What I was thinking here was more "real-world" examples and recipes. Basically, common use cases and documentation for how you would solve them, maybe with some commentary on the tradeoffs between different options. Tests are sometimes difficult to wade through to find the ones that are actually good examples of how the library should be used vs how the library should behave. |
Hey @camdencheek What do you mean by Adding an examples folder with richer examples? I am new here and I need guidance in order to solve this issue and other ones also. |
Hi @ibilalkayy, thanks for reaching out! The goal of this task is to create a set of runnable examples of how There are other packages that do this really well that you could use as a model. For some inspiration, you can take a look at how Sourcegraph uses |
@camdencheek, I think I should understand what I am sorry I jumped into the issues without using source graphs and understanding Thank you! |
@ibilalkayy,
The link I posted above shows all the places we use |
Maybe add Go Playground to README.md and add more usage examples |
Any updates on this? Some good ideas:
|
@camdencheek: Really lovely looking library, going to try it right now.
Premature optimization is an absolute killer, it starts out innocently enough but left unchecked it will destroy your productivity and confidence. Also fancy abstractions like this are great (and I'm surprised this slipped past me, excited use them) but not learning how things actually work under the hood is another pitfall, one that actually held me back for years.
Beyond the scope of this project, this is about avoiding some of the more pernicious bugs that aren't already easy to debug and cleaner code (I suspect). You're going to be writing more or less exactly the same code. |
There are a lot of use cases that aren't covered in the README. It would be nice to have a runnable "examples" folder that includes a bunch of common recipes.
The text was updated successfully, but these errors were encountered: