doc: fix nits in dgram.md #29761
Closed
doc: fix nits in dgram.md #29761
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
dgram
addaleax
approved these changes
Sep 29, 2019
doc/api/dgram.md
Outdated
| #### Change to asynchronous `socket.bind()` behavior | ||
|
|
||
| As of Node.js v0.10, [`dgram.Socket#bind()`][] changed to an asynchronous | ||
| execution model. Legacy code would use synchronous behavior: |
There was a problem hiding this comment.
I feel like Node v0.10 might be long ago by now that this can just be a YAML changes: entry (without examples)
There was a problem hiding this comment.
Is there a simple way to find a PR URL for YAML with this old change?
There was a problem hiding this comment.
Also, is this change also relevant for the next socket.bind(options[, callback]) signature? It was added in v0.11.14, i.e. in the version where the previous signature was already asynchronous, so may be it is not relevant. But I may miss simething.
There was a problem hiding this comment.
Amended to make it a YAML section for the first (older) signature.
* Make a section with a history remark a YAML section of the relevant method. Refs: #29761 (comment) * Make a bold line a real heading to be included in the TOC. * Add formal return types. * Reduce redundancy in a description. * Unify link format. * Fix ASCII sorting in bottom references.
Trott
approved these changes
Sep 29, 2019
lpinca
approved these changes
Sep 29, 2019
trivikr
approved these changes
Sep 29, 2019
Trott
added
the
author ready
JungMinu
approved these changes
Sep 30, 2019
JungMinu
approved these changes
Sep 30, 2019
cjihrig
approved these changes
Sep 30, 2019
jasnell
approved these changes
Sep 30, 2019
BridgeAR
approved these changes
Oct 1, 2019
|
Landed in ddcd235 |
Trott
pushed a commit
to Trott/io.js
that referenced
this pull request
Oct 1, 2019
* Make a section with a history remark a YAML section of the relevant method. Refs: nodejs#29761 (comment) * Make a bold line a real heading to be included in the TOC. * Add formal return types. * Reduce redundancy in a description. * Unify link format. * Fix ASCII sorting in bottom references. PR-URL: nodejs#29761 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
BridgeAR
pushed a commit
that referenced
this pull request
Oct 9, 2019
* Make a section with a history remark a YAML section of the relevant method. Refs: #29761 (comment) * Make a bold line a real heading to be included in the TOC. * Add formal return types. * Reduce redundancy in a description. * Unify link format. * Fix ASCII sorting in bottom references. PR-URL: #29761 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Merged
This was referenced May 9, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes