log/syslog: Dial function needs examples

[geofffranks]

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.

[gopherbot]

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

[geofffranks]

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]

Isn't syslog frozen?

[geofffranks]

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]

Documentation is okay.