errors: update documentation #598
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 `successABCICode` public variable - update documentation resolve #494
ethanfrey
approved these changes
May 8, 2019
errors/doc.go
Outdated
| Error declarations should be generic and cover broad range of cases. Each | ||
| returned error instance can wrap a generic error declaration to provide more | ||
| details. | ||
| Unless an error is very specific for an extension (ie ErrInvalidSequence in |
There was a problem hiding this comment.
s/Unless/If/
(as it reads, it seems opposite to what you intended)
There was a problem hiding this comment.
And maybe a line before suggesting to use the generic errors registered in this module if possible
| } | ||
|
|
||
| The first time an error instance is wrapped a stacktrace is attached as well. | ||
| Stacktrace information can be printed using %+v and %v formats. |
There was a problem hiding this comment.
I think nice to include this info (unless no longer valid). Possibly formatted differently
%+v is the full stack trace
%v appends a compressed [filename:line] where the error was created
husio
force-pushed
the
error_improvements_issue_494
branch
from
51edc25 to
5496a17
Compare
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.
successABCICodepublic variableresolve #494