docs: clarify Wrapf deprecation and fmt.Errorf Go 1.13+ wrapping - #65
Open
AdamMagued wants to merge 1 commit into
Open
AdamMagued wants to merge 1 commit into
AdamMagued wants to merge 1 commit into
Conversation
Update Wrapf docstring and README to clarify that Go 1.13+ supports native error wrapping via fmt.Errorf("%w", ...). Remove the outdated recommendation to replace fmt.Errorf with Wrapf, and update the basic usage example in the README to use fmt.Errorf instead of deprecated Wrapf.
Fixes hashicorp#12
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Adam Magued seems not to be a GitHub user. Have you signed the CLA already but the status is still pending? Recheck it. |
This file contains hidden or 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
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.
Contributor Checklist
PCI review checklist
Description
In
errwrap.go, the docstring forWrapfpreviously stated that users should replacefmt.ErrorfwithWrapf, while directly below markingWrapfasDeprecated: Use fmt.Errorf().Additionally,
README.mdnoted that wrapping withfmt.Errorfloses error structure, and used deprecatederrwrap.Wrapfin the basic usage example.This change:
Wrapfdocstring that Go 1.13+ natively supports error wrapping viafmt.Errorf("%w", ...).fmt.ErrorfwithWrapf.README.mdto note that prior to Go 1.13 wrapping viafmt.Errorflost error structure, while Go 1.13+ supports native wrapping viafmt.Errorf("%w", ...).README.mdto usefmt.Errorf("%w", ...)instead of deprecatedWrapf.Fixes #12