docs(readme): add error-handling to example code #513
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
The current README includes quite a few code snippets that include no error-handling. If someone is trying to learn this library for the first time, it can make understanding why things fail much more difficult without first adding this error-handling to their own code. It's just good hygiene in Go to handle errors, so I think our examples should reflect that, rather than try so hard to keep the code shorter.
dominicbarnes
force-pushed
the
readme-error-handling
branch
from
09e9d9c to
a5185a8
Compare
achille-roussel
approved these changes
Sep 18, 2020
stevevls
approved these changes
Sep 18, 2020
|
@stevevls I'm open to either approach, just as long as we're consistent. I tend to lean towards this as it's likely closer to what a user would do in practice, aside from |
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.
The current README includes quite a few code snippets that include no error-handling. If someone is trying to learn this library for the first time, it can make understanding why things fail much more difficult without first adding this error-handling to their own code.
It's just good hygiene in Go to handle errors, so I think our examples should reflect that, rather than try so hard to keep the code shorter.