Add more comments to examples #100
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make the transcoder examples into package-level examples so they're a little more prominent in pkg.go.dev. It also adds some more comments to the examples, hopefully walking readers through what's happening a little more slowly.
emcfarlane
approved these changes
Oct 25, 2023
vanguard_examples_test.go
Outdated
| if err != nil { | ||
| log.Println("error:", err) | ||
| log.Println(err) |
There was a problem hiding this comment.
Did you intentionally not use logger here?
There was a problem hiding this comment.
Nope 🤦🏽 Thanks for the catch!
jhump
approved these changes
Oct 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR attempts to make the GoDoc examples more of a guided tour: it makes the
comments more of a narrative walkthrough, and it moves them to the package
level (so they're displayed more prominently on pkg.go.dev).