doc: add links between cork() and uncork() #11222
Closed
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
mcollina
added
doc
nodejs-github-bot
added
doc
cjihrig
reviewed
Feb 7, 2017
| @@ -347,6 +347,8 @@ buffer that would have an adverse impact on performance. In such situations, | |||
| implementations that implement the `writable._writev()` method can perform | |||
| buffered writes in a more optimized manner. | |||
|
|
|||
| See also: [`writable.uncork()`][]. | |||
There was a problem hiding this comment.
Does this work without defining cork() and uncork() in the links at the bottom of the page?
There was a problem hiding this comment.
It did not. Now it does.
Fishrock123
approved these changes
Feb 7, 2017
jasnell
approved these changes
Feb 7, 2017
Writable.cork() and Writable.uncork() are meant to be documented together, but we maintain a lexicographic order. This commit introduces some links between the two. Fixes: nodejs#7340
|
Updated with @cjihrig and @Fishrock123 suggestion. |
addaleax
approved these changes
Feb 8, 2017
|
Landed as c38b6d2 |
mcollina
added a commit
that referenced
this pull request
Feb 9, 2017
Writable.cork() and Writable.uncork() are meant to be documented together, but we maintain a lexicographic order. This commit introduces some links between the two. Fixes: #7340 PR-URL: #11222 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Feb 9, 2017
Writable.cork() and Writable.uncork() are meant to be documented together, but we maintain a lexicographic order. This commit introduces some links between the two. Fixes: nodejs#7340 PR-URL: nodejs#11222 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Feb 14, 2017
Writable.cork() and Writable.uncork() are meant to be documented together, but we maintain a lexicographic order. This commit introduces some links between the two. Fixes: nodejs#7340 PR-URL: nodejs#11222 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
krydos
pushed a commit
to krydos/node
that referenced
this pull request
Feb 25, 2017
Writable.cork() and Writable.uncork() are meant to be documented together, but we maintain a lexicographic order. This commit introduces some links between the two. Fixes: nodejs#7340 PR-URL: nodejs#11222 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
|
needs a backport PR to land on v4 |
jasnell
pushed a commit
that referenced
this pull request
Mar 7, 2017
Writable.cork() and Writable.uncork() are meant to be documented together, but we maintain a lexicographic order. This commit introduces some links between the two. Fixes: #7340 PR-URL: #11222 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
|
Do we need to backport? |
|
not necessarily. just indicating that a backport would be needed if we did want to land it in those branches |
MylesBorins
pushed a commit
that referenced
this pull request
Mar 9, 2017
Writable.cork() and Writable.uncork() are meant to be documented together, but we maintain a lexicographic order. This commit introduces some links between the two. Fixes: #7340 PR-URL: #11222 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Merged
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.
Writable.cork() and Writable.uncork() are meant to be documented
together, but we maintain a lexicographic order. This commit
introduces some links between the two.
Fixes: #7340
Implements @addaleax suggestion in #7340 (comment)
Checklist
Affected core subsystem(s)
doc, stream