Possible issue in docs for Listen and ListenPacket

66 views
Skip to first unread message

John Dreystadt

unread,
Feb 26, 2021, 3:07:11 PM2/26/21
to golang-nuts
The documentation for  func (*ListenConfig) Listen ends with the line "See func Listen for a description of the network and address parameters". The next function called ListenPacket has the same line with the name changed to ListenPacket. I think that these should actually say "See func Dial for a description of the network and address parameters". Can someone show me what I am missing? If not, I can open an issue.

Ian Lance Taylor

unread,
Feb 26, 2021, 4:00:59 PM2/26/21
to John Dreystadt, golang-nuts
On Fri, Feb 26, 2021 at 12:07 PM John Dreystadt <jdrey...@gmail.com> wrote:
>
> The documentation for func (*ListenConfig) Listen ends with the line "See func Listen for a description of the network and address parameters". The next function called ListenPacket has the same line with the name changed to ListenPacket. I think that these should actually say "See func Dial for a description of the network and address parameters". Can someone show me what I am missing? If not, I can open an issue.

The documentation is not wrong, in that the function Listen does have
network and address parameters. But it's also true that the docs for
Listen, and ListenPacket, say "// See func Dial for a description of
the network and address parameters." So it would be reasonable for
the Listen and ListenPacket methods to also refer directly to Dial.
Feel free to open an issue or to just send a fix without opening an
issue. Thanks.

Ian
Reply all
Reply to author
Forward
0 new messages