doc: add links between cork() and uncork() #11222

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
6 participants
@mcollina
Member

mcollina commented 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: #7340

Implements @addaleax suggestion in #7340 (comment)

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, stream

@mcollina mcollina requested a review from addaleax 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()`][].

This comment has been minimized.

@cjihrig

cjihrig Feb 7, 2017

Contributor

Does this work without defining cork() and uncork() in the links at the bottom of the page?

@cjihrig

cjihrig Feb 7, 2017

Contributor

Does this work without defining cork() and uncork() in the links at the bottom of the page?

This comment has been minimized.

@mcollina

mcollina Feb 7, 2017

Member

It did not. Now it does.

@mcollina

mcollina Feb 7, 2017

Member

It did not. Now it does.

@cjihrig

cjihrig approved these changes Feb 7, 2017

LGTM with one comment.

@Fishrock123

LGTM with @cjihrig's comment

@jasnell

jasnell approved these changes Feb 7, 2017

doc: add links between cork() and uncork()
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
@mcollina

This comment has been minimized.

Show comment
Hide comment
@mcollina

mcollina Feb 7, 2017

Member

Updated with @cjihrig and @Fishrock123 suggestion.

Member

mcollina commented Feb 7, 2017

Updated with @cjihrig and @Fishrock123 suggestion.

@mcollina

This comment has been minimized.

Show comment
Hide comment
@mcollina

mcollina Feb 9, 2017

Member

Landed as c38b6d2

Member

mcollina commented Feb 9, 2017

Landed as c38b6d2

@mcollina mcollina closed this Feb 9, 2017

mcollina added a commit that referenced this pull request Feb 9, 2017

doc: add links between cork() and uncork()
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 added a commit to italoacasas/node that referenced this pull request Feb 9, 2017

doc: add links between cork() and uncork()
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 added a commit to italoacasas/node that referenced this pull request Feb 14, 2017

doc: add links between cork() and uncork()
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 added a commit to KryDos/node that referenced this pull request Feb 25, 2017

doc: add links between cork() and uncork()
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>
@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Mar 7, 2017

Member

needs a backport PR to land on v4

Member

jasnell commented Mar 7, 2017

needs a backport PR to land on v4

jasnell added a commit that referenced this pull request Mar 7, 2017

doc: add links between cork() and uncork()
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>
@mcollina

This comment has been minimized.

Show comment
Hide comment
@mcollina

mcollina Mar 7, 2017

Member

Do we need to backport?

Member

mcollina commented Mar 7, 2017

Do we need to backport?

@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Mar 7, 2017

Member

not necessarily. just indicating that a backport would be needed if we did want to land it in those branches

Member

jasnell commented Mar 7, 2017

not necessarily. just indicating that a backport would be needed if we did want to land it in those branches

MylesBorins added a commit that referenced this pull request Mar 9, 2017

doc: add links between cork() and uncork()
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>

@MylesBorins MylesBorins referenced this pull request Mar 9, 2017

Merged

v6.10.1 proposal #11759

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment