-
Notifications
You must be signed in to change notification settings - Fork 1.6k
📖 Improve error format in the design docs for API Versioning in Kubebuilder #4693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 Improve error format in the design docs for API Versioning in Kubebuilder #4693
Conversation
…n.md` design doc - Updated `fmt.Errorf` to use `%w` for proper error wrapping in code snippets - Improves consistency and error traceability in example code
Hi @kersten. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
@@ -158,12 +158,12 @@ func (ch *conversionHandler) convertObject(src, dst runtime.Object) error { | |||
|
|||
err = src.(conversion.Convertible).ConvertTo(hub) | |||
if err != nil { | |||
return fmt.Errorf("%T failed to convert to hub version %T : %v", src, hub, err) | |||
return fmt.Errorf("%T failed to convert to hub version %T : %w", src, hub, err) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See that it has a symble in red.
Can you please check we probably need to fix it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is strange, here is my git diff to the master branch:
diff --git a/designs/crd_version_conversion.md b/designs/crd_version_conversion.md
index 8176e024c..728613189 100644
--- a/designs/crd_version_conversion.md
+++ b/designs/crd_version_conversion.md
@@ -158,12 +158,12 @@ func (ch *conversionHandler) convertObject(src, dst runtime.Object) error {
err = src.(conversion.Convertible).ConvertTo(hub)
if err != nil {
- return fmt.Errorf("%T failed to convert to hub version %T : %w", src, hub, err)
+ return fmt.Errorf("%T failed to convert to hub version %T : %v", src, hub, err)
}
err = dst.(conversion.Convertible).ConvertFrom(hub)
if err != nil {
- return fmt.Errorf("%T failed to convert from hub version %T : %w", dst, hub, err)
+ return fmt.Errorf("%T failed to convert from hub version %T : %v", dst, hub, err)
}
return nil
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is just a design doc as well so I think is all fine .. I am moving forward
%w
in crd_version_conversion.md
design docThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/approve
/ok-to-test
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, kersten The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
fmt.Errorf
to use%w
for proper error wrapping in code snippets