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

net: Resolver.LookupSRV first result param not documented well #49982

Open
bradfitz opened this issue Dec 4, 2021 · 1 comment · May be fixed by #49995
Open

net: Resolver.LookupSRV first result param not documented well #49982

bradfitz opened this issue Dec 4, 2021 · 1 comment · May be fixed by #49995
Labels
Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@bradfitz
Copy link
Contributor

bradfitz commented Dec 4, 2021

https://pkg.go.dev/net#Resolver.LookupSRV has signature:

func (r *Resolver) LookupSRV(ctx context.Context, service, proto, name string) (string, []*SRV, error)

... but the docs don't make it super clear what that string result is.

There's a hint in the docs:

LookupSRV constructs the DNS name to look up following RFC 2782. That is, it looks up _service._proto.name.

But that makes it sound like it's an implementation detail, not that the first result is indeed that DNS name.

@ianlancetaylor ianlancetaylor added this to the Backlog milestone Dec 5, 2021
@ianlancetaylor ianlancetaylor added help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Dec 5, 2021
@ichxxx ichxxx linked a pull request Dec 6, 2021 that will close this issue
@gopherbot
Copy link

gopherbot commented Dec 6, 2021

Change https://golang.org/cl/369554 mentions this issue: net: fix typo in comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants