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

resolver: remove outdated Target examples #6547

Merged
merged 1 commit into from
Aug 14, 2023

Conversation

philippgille
Copy link
Contributor

@philippgille philippgille commented Aug 13, 2023

This PR aims to resolve #6496, in which an outdated Godoc was noticed. In the past the resolver.Target struct contained three different fields, but nowadays it's only URL, but the examples in the Godoc still referenced the old fields.

As the Target doesn't seem to be usually created directly by a user of grpc-go, but instead through Dial or DialContext, it seems reasonable to just remove the examples instead of replacing them with an example where a target string is manually parsed with url.Parse.

RELEASE NOTES: none

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 13, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: philippgille / name: Philipp Gillé (8865d75)

@easwars easwars added the Type: Documentation Documentation or examples label Aug 14, 2023
@easwars easwars added this to the 1.58 Release milestone Aug 14, 2023
@easwars
Copy link
Contributor

easwars commented Aug 14, 2023

@philippgille : Would you mind rebasing your branch to master. We recently fixed something that will take care of one of the failing tests in this PR. Thanks.

@easwars
Copy link
Contributor

easwars commented Aug 14, 2023

@ginayeh : For second set of eyes

@dfawley
Copy link
Member

dfawley commented Aug 14, 2023

The failing test is vet-proto which does not need to pass in order to be merged (and appears to be broken again by a recent upstream change).

@dfawley dfawley merged commit 2821d7f into grpc:master Aug 14, 2023
1 check passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Type: Documentation Documentation or examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Godoc of resolver.Target
4 participants