doc: correct dgram's Socket.bind required args - #11025
Conversation
Sorry, something went wrong.
There was a problem hiding this comment.
I know its not your text, but could you add after
If port is not specified
"or is 0"
Sorry, something went wrong.
There was a problem hiding this comment.
@sam-github 👍 just pushed a fix
Sorry, something went wrong.
There was a problem hiding this comment.
Unfortunately, socket.bind(port) and socket.bind(options) have cut-n-pasted docs, so you need to change in both places (or document the number variant by referring to the options variant).
Sorry, something went wrong.
There was a problem hiding this comment.
@sam-github pushed another fix. As a bonus I synced up some additional information that was missing from the options form.
Sorry, something went wrong.
There was a problem hiding this comment.
Unfortunately, socket.bind(port) and socket.bind(options) have cut-n-pasted docs, so you need to change in both places (or document the number variant by referring to the options variant).
Sorry, something went wrong.
`port` was listed as required, but as described in the following paragraphs, it's actually not. Also, note that setting `port` to `0` will also cause the OS to assign a a random port and sync up the docs of both forms.
|
@sam-github ping - this should be good to merge, no? |
Sorry, something went wrong.
`port` was listed as required, but as described in the following paragraphs, it's actually not. Also, note that setting `port` to `0` will also cause the OS to assign a a random port and sync up the docs of both forms. PR-URL: #11025 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
`port` was listed as required, but as described in the following paragraphs, it's actually not. Also, note that setting `port` to `0` will also cause the OS to assign a a random port and sync up the docs of both forms. PR-URL: #11025 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
`port` was listed as required, but as described in the following paragraphs, it's actually not. Also, note that setting `port` to `0` will also cause the OS to assign a a random port and sync up the docs of both forms. PR-URL: #11025 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
`port` was listed as required, but as described in the following paragraphs, it's actually not. Also, note that setting `port` to `0` will also cause the OS to assign a a random port and sync up the docs of both forms. PR-URL: #11025 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
`port` was listed as required, but as described in the following paragraphs, it's actually not. Also, note that setting `port` to `0` will also cause the OS to assign a a random port and sync up the docs of both forms. PR-URL: #11025 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
`port` was listed as required, but as described in the following paragraphs, it's actually not. Also, note that setting `port` to `0` will also cause the OS to assign a a random port and sync up the docs of both forms. PR-URL: #11025 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
port was listed as required, but as described in the following paragraphs, it's actually not.
Checklist
Affected core subsystem(s)
doc