-
Notifications
You must be signed in to change notification settings - Fork 1
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
More complete examples, better READMEs #13
Conversation
0b8bc75
to
c692ebd
Compare
|
||
go 1.20 | ||
|
||
// TODO don't use the local repo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO
for the user playing with this example right? Then this is ok here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes and no. It's super not important given that these are examples, but yes it's also a hint to the user "don't do this".
examples/http/README.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this nice example now has the added responsibility of showing a bit of context in db queries, could we also have some of that info added to this readme? Some of that is already commented in main.go
, e.g. The SQL commenter helps associate queries with traces.
and It's important to inject the request context into the query call because it carries the current trace information
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've updated the intro paragraph. Care to take another look?
Thanks @swi-jared ! Just a few suggestions/questions I had. |
Co-authored-by: Tammy Baylis <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @swi-jared !!
Here's a link to the branch in github so you can click around the READMEs.