Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix typo in merge2 #5489

Merged
merged 1 commit into from Dec 21, 2023
Merged

Fix typo in merge2 #5489

merged 1 commit into from Dec 21, 2023

Conversation

ltearno
Copy link
Contributor

@ltearno ltearno commented Dec 13, 2023

The moved comment obviously is associated with the code that enshures Merger implements Visitor

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Dec 13, 2023 •
edited

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: ltearno / name: Arnaud Tournier (665bfbc)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Dec 13, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @ltearno!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 13, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @ltearno. 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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 13, 2023
koba1t
koba1t reviewed Dec 20, 2023
View reviewed changes
kyaml/yaml/merge2/merge2.go
@@ -45,9 +45,9 @@ func MergeStrings(srcStr, destStr string, infer bool, mergeOptions yaml.MergeOpt
}

type Merger struct {
// for forwards compatibility when new functions are added to the interface
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel this comment means that when we need to add some field in this struct.
So, I think this comment is still in the right place.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @koba1t , and thanks for your review! I think I disagree with you on your point:
As far as I understand, the comment is applying to the pattern that is used to ensure that if functions are added to the walk.Visitor interface, the struct will still implement all of them (if not, the build will failed because of the line var _ walk.Visitor = Merger{}).
And also the comment refers to the interface, which Merger is not (it is a struct), so again, the comment should apply to the line mentioned above.
So if a new function is added on the walk.Visitor interface, the line var _ walk.Visitor = Merger{} will ensure that the Merger struct is still (forward-)compatible with the interface, which is basically what the comment is saying.
WDYT?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, Thanks for describing this code. I misunderstood walk.Visitor as not an interface.
I agree with what you are doing now.

@koba1t
Copy link
Member

koba1t commented Dec 20, 2023

Hi @ltearno
Thanks for your contribution!

I added a comment with my thoughts.
Please feel free to say that if you feel I made a mistake!

@ltearno ltearno requested a review from koba1t December 21, 2023 07:57
@koba1t
Copy link
Member

koba1t commented Dec 21, 2023

Thanks for your contribution!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 21, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: koba1t, ltearno

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 21, 2023
@k8s-ci-robot k8s-ci-robot merged commit b28e044 into kubernetes-sigs:master Dec 21, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@varshaprasad96 varshaprasad96 Awaiting requested review from varshaprasad96

@koba1t koba1t Awaiting requested review from koba1t

Assignees

@koba1t koba1t

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@ltearno @k8s-ci-robot @koba1t