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

doc: fix nits in dgram.md #29761

Closed
wants to merge 1 commit into from
Closed

doc: fix nits in dgram.md #29761

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt commented Sep 29, 2019 •
edited
Loading

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
  • Make a section with a history remark a YAML section of the relevant method. Refs: doc: fix nits in dgram.md #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.

@nodejs-github-bot nodejs-github-bot added dgram Issues and PRs related to the dgram subsystem / UDP. doc Issues and PRs related to the documentations. labels Sep 29, 2019
addaleax
addaleax approved these changes Sep 29, 2019
View reviewed changes
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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like Node v0.10 might be long ago by now that this can just be a YAML changes: entry (without examples)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a simple way to find a PR URL for YAML with this old change?

Copy link
Contributor Author

@vsemozhetbyt vsemozhetbyt Sep 29, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’d omit it, because that was before the time that Node.js necessarily had PRs for commits :)

332fea5 was the change itself and 7169436 added the docs for that (so, like, ~7 years ago).

Copy link
Contributor Author

@vsemozhetbyt vsemozhetbyt Sep 29, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amended to make it a YAML section for the first (older) signature.

@vsemozhetbyt
doc: fix nits in dgram.md
3aedcda 
* 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
Copy link
Member

Trott commented Sep 29, 2019

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3944/

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 29, 2019
@Trott
Copy link
Member

Trott commented Oct 1, 2019

Landed in ddcd235

@Trott Trott closed this Oct 1, 2019
Trott pushed a commit to Trott/io.js that referenced this pull request Oct 1, 2019
@vsemozhetbyt @Trott
doc: fix nits in dgram.md
ddcd235 
* 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 <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Minwoo Jung <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
@vsemozhetbyt vsemozhetbyt deleted the doc-fix-nits-dgram branch October 2, 2019 01:19
BridgeAR pushed a commit that referenced this pull request Oct 9, 2019
@vsemozhetbyt @BridgeAR
doc: fix nits in dgram.md
401f3e7 
* 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 <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Minwoo Jung <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
@BridgeAR BridgeAR mentioned this pull request Oct 10, 2019
Merged
@kissofire kissofire mentioned this pull request Feb 25, 2021
Open
@aliceUnhinged613 aliceUnhinged613 mentioned this pull request Feb 25, 2021
Open
@ron-a20 ron-a20 mentioned this pull request Feb 26, 2021
Open
@sitedata sitedata mentioned this pull request Feb 26, 2021
Open
@meghasfdc meghasfdc mentioned this pull request Feb 26, 2021
Open
@137717unity 137717unity mentioned this pull request Feb 26, 2021
Open
@Rednickle Rednickle mentioned this pull request Feb 26, 2021
Open
This was referenced May 5, 2021
Open
Closed
Closed
This was referenced May 9, 2021
Open
Open
@snyk-bot snyk-bot mentioned this pull request May 26, 2021
Open
@aliceUnhinged613 aliceUnhinged613 mentioned this pull request Oct 30, 2022
Open
@137717unity 137717unity mentioned this pull request Oct 30, 2022
Open
@molllyn1 molllyn1 mentioned this pull request Oct 30, 2022
Open
@kissofire kissofire mentioned this pull request Oct 30, 2022
Open
@wedataintelligence wedataintelligence mentioned this pull request Oct 30, 2022
Open
@snyk-bot snyk-bot mentioned this pull request Oct 31, 2022
Open
@ron-a20 ron-a20 mentioned this pull request Oct 31, 2022
Open
@snyk-bot snyk-bot mentioned this pull request Oct 31, 2022
Open
@snyk-bot snyk-bot mentioned this pull request Nov 10, 2022
Open
@kissofire kissofire mentioned this pull request Dec 6, 2023
Open
@137717unity 137717unity mentioned this pull request Dec 6, 2023
Open
@ron-a20 ron-a20 mentioned this pull request Dec 6, 2023
Open
@aliceUnhinged613 aliceUnhinged613 mentioned this pull request Dec 6, 2023
Open
@wedataintelligence wedataintelligence mentioned this pull request Dec 7, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@addaleax addaleax addaleax approved these changes

@trivikr trivikr trivikr approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@JungMinu JungMinu JungMinu approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@Trott Trott Trott approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. dgram Issues and PRs related to the dgram subsystem / UDP. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@vsemozhetbyt @Trott @jasnell @addaleax @lpinca @cjihrig @JungMinu @BridgeAR @trivikr @nodejs-github-bot