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

log/syslog: Dial function needs examples #16761

Closed
geofffranks opened this issue Aug 17, 2016 · 5 comments
Closed

log/syslog: Dial function needs examples #16761

geofffranks opened this issue Aug 17, 2016 · 5 comments
Labels
Documentation FrozenDueToAge
Milestone
Go1.8

Comments

@geofffranks
Copy link

Please answer these questions before submitting your issue. Thanks!

  1. What version of Go are you using (go version)?

    1.7

  2. What operating system and processor architecture are you using (go env)?

darwin/amd_64

  1. What did you do?

Tried to view the docs for https://golang.org/pkg/log/syslog/#Dial

  1. What did you expect to see?

Documentation/examples describing what the 'network' and 'raddr' values should be.

  1. What did you see instead?

No mention of what those should be. It appears 'network' refers to 'address family' or 'protocol' (tcp/udp/unix/unixgram), rather than some string representing a network address. 'raddr' seems to be the 'host:port', or file path string for connecting to the socket. I had to browse the test suite's source code to figure out what these should be.
@bradfitz bradfitz self-assigned this Aug 17, 2016
@bradfitz bradfitz added this to the Go1.8 milestone Aug 17, 2016
@bradfitz bradfitz changed the title log/syslog Dial() function needs examples log/syslog: Dial function needs examples Aug 17, 2016
@gopherbot
Copy link

CL https://golang.org/cl/27209 mentions this issue.

@geofffranks
Copy link
Author

Thanks!

On Aug 17, 2016, at 11:01 AM, GopherBot notifications@github.com wrote:

CL https://golang.org/cl/27209 https://golang.org/cl/27209 mentions this issue.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub #16761 (comment), or mute the thread https://github.com/notifications/unsubscribe-auth/AG2SUpWdyQ3jLiSiSQci-cw2zWDggSrxks5qgyJYgaJpZM4JmgZw.

@magical
Copy link
Contributor

magical commented Aug 18, 2016

Isn't syslog frozen?

@geofffranks
Copy link
Author

My understanding is that frozen indicates people can expect not to notice API or under the hood functionality changes moving forward, but I don't see how clarifying documentation should ever be dissuaded.

Sent from my iPhone

On Aug 18, 2016, at 2:15 AM, Andrew Ekstedt notifications@github.com wrote:

Isn't syslog frozen?

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute the thread.

@bradfitz
Copy link
Contributor

Documentation is okay.

@golang golang locked and limited conversation to collaborators Aug 19, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge
Projects
None yet
Milestone
Go1.8
Development

No branches or pull requests
4 participants
@bradfitz @magical @geofffranks @gopherbot