stream docs, writable.cork() and writable.uncork() methods #7340
Comments
italoacasas
changed the title
|
You're right, but I think the overall doc experience is better if everything is predictably in alphabetical order. |
|
Yes, alphabetical order I think is the right choose, but on my opinion we can improve the experience if we make an exception on this case. |
|
There are many other cases in the documentation where an exception would be warranted. The problem is that if you keep making exceptions, then the documentation loses all consistency. |
|
I'm -1 on changing the order. Improving the documentation so that the links between the two are clearer is definitely a good idea. |
|
How about adding |
|
Makes sense to me. |
|
On a side note - it seems these methods are moot for socket connections to non local servers? Using cork / uncork to buffer writes to a local connection practically doubles the op/s. But to a remote server it halves it...? 😭 Is there any different logic for non-local connections? See redis/ioredis#343 that PR I did, I switched to not using cork as it's more performant (~70k ops/s more), but even with a cork/uncork implementation the result on remote servers is the same - worse. If there is some different logic then is it worth documenting this? |
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
|
Fixed in c38b6d2 |
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 <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
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 <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
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 <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
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 <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
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 <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
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 <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Working on #7287 I notice that writable.cork() and writable.uncork() are not together, I guess it's because the alphabetical order, but I think the experience reading the stream documentation is going to be better if they live together.
The text was updated successfully, but these errors were encountered: