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.

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

changed docstring in shared_types.go to account for empty strings being an error #1376

Merged

Conversation

asim-reza
Copy link
Contributor

Issue
ParentReference.Namespace has unnecessary pointer to string. #1220

What type of PR is this?
/kind documentation

What this PR does / why we need it:
In reference to the Issue mentioned above (#1220) it was decided that setting the value as an empty string for the field namespace is an error, and this is now reflected in its docstring

Which issue(s) this PR fixes:
Fixes #1220

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 5, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @asim-reza!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. 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/gateway-api 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 Sep 5, 2022
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 5, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @asim-reza. 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.

Copy link
Contributor

@markmc markmc left a comment

Choose a reason for hiding this comment

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

Thank you for your patch!

Could you also make this change to the v1beta1 docs?

Comment on lines 49 to 51
// Namespace is the namespace of the referent. When unspecified, this refers
// to the local namespace of the Route. Refer to the Namespace type for valid
// values.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Namespace is the namespace of the referent. When unspecified, this refers
// to the local namespace of the Route. Refer to the Namespace type for valid
// values.
// Namespace is the namespace of the referent. When unspecified, this refers
// to the local namespace of the Route.

I think the "Refer to the Namespace type" bit isn't useful because the docs will include a link to that type. If it was useful, we'd have to say it everywhere for every type.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey! I think I made the change for both v1alpha2 and v1beta1... Unless I pushed it wrong

@k8s-ci-robot
Copy link
Contributor

@markmc: The label(s) /label ok-to-test cannot be applied. These labels are supported: api-review, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, team/katacoda, refactor

In response to this:

Thank you for your patch!

Could you also make this change to the v1beta1 docs?

/label ok-to-test

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.

@markmc
Copy link
Contributor

markmc commented Sep 5, 2022

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 5, 2022
@asim-reza
Copy link
Contributor Author

/retest

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 5, 2022
@markmc
Copy link
Contributor

markmc commented Sep 5, 2022

Thanks!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 5, 2022
@asim-reza
Copy link
Contributor Author

/test pull-gateway-api-verify

@asim-reza
Copy link
Contributor Author

@keithmattix
@youngnick

@youngnick
Copy link
Contributor

This LGTM, nice work.

Running make generate and pushing the result should clear up the CI failures.

Once that's done, I'll approve. Thanks for making your first change!

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 6, 2022
@youngnick
Copy link
Contributor

/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 Sep 6, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: asim-reza, youngnick

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 Sep 6, 2022
@k8s-ci-robot k8s-ci-robot merged commit 1b92349 into kubernetes-sigs:main Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ParentReference.Namespace has unnecessary pointer to string.
4 participants