Do not use errgo nor pkg/errors for root errors, matches stdlib #584
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
Soulou
force-pushed
the
feat/582/match-stdlib
branch
from
7664a77 to
d310f9d
Compare
EtienneM
reviewed
Apr 11, 2023
Comment on lines
+28
to
+31
| // New wraps errors.New from the pkg/errors library | ||
| // | ||
| // These errors are usually created outside any function code at the top of | ||
| // files, so no context is needed. |
There was a problem hiding this comment.
suggestion: I would keep a first line of comment explaining what this function do.
Suggested change
| // New wraps errors.New from the pkg/errors library | |
| // | |
| // These errors are usually created outside any function code at the top of | |
| // files, so no context is needed. | |
| // New returns an error that formats as the given text. | |
| // New wraps errors.New from the pkg/errors library | |
| // | |
| // These errors are usually created outside any function code at the top of | |
| // files, so no context is needed. |
| } | ||
|
|
||
| func Errorf(ctx context.Context, format string, args ...interface{}) error { |
There was a problem hiding this comment.
Do we need both Newf and Errorf? correct me if I'm wrong but they seem identical.
There was a problem hiding this comment.
You're right it was to prevent breaking the API more
There was a problem hiding this comment.
Hence should we mark one of these two methods as deprecated?
Co-authored-by: Étienne M. <[email protected]>
Co-authored-by: Étienne M. <[email protected]>
EtienneM
approved these changes
May 4, 2023
| } | ||
|
|
||
| func Errorf(ctx context.Context, format string, args ...interface{}) error { |
There was a problem hiding this comment.
Hence should we mark one of these two methods as deprecated?
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.
Expose
Newto create simple string errors, wrapping pkg/errors.NewExpose NewWithContext/Newf/Errorf, to create errors which are not wrapping others
Related to #582