Cherrypick v0.12 doc updates #2302
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
Per nodejs#4409, the documentation on http.abort is a bit lacking. This provides a slight improvement. Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
per: nodejs/node-v0.x-archive#6847 Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
Per: nodejs/node-v0.x-archive@b7229de The documentation for createWriteStream() references an 'encoding' property that has a default value of null. However, this property is never referenced by createWriteStream() or WritableState(). Instead a 'defaultEncoding' property is referenced in WritableState() with a default of 'utf8' if no value is supplied. This fix updates the documentation to rename the 'encoding' property to 'defaultEncoding' and indicate its default value of 'utf8'. Originally Contributed By: @chrisneave (The original patch did not apply clean)
per: nodejs/node-v0.x-archive@53b6a61 fixes nodejs/node-v0.x-archive#7230 Original commit patch did not apply cleanly Originally contributed by @sarathms
Original: nodejs/node-v0.x-archive#8682 Slightly modified version of the original PR (nodejs#8682) to add appropriate line wrapping and fix a couple of grammar nits. Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
Per: nodejs/node-v0.x-archive@16f5476 Originally contributed by: @scop Original commit patch did not apply cleanly
Per: nodejs/node-v0.x-archive@5ccb429 Originally contributed by @scop Original commit patch did not apply cleanly
per: nodejs/node-v0.x-archive@59c67fe Originally contributed by @skypjack Original commit patch did not land cleanly
'the' to 'then' Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
Made explicitely clear that when size bytes are not available, it will return null, unless we've ended, in which case the data remaining in the buffer will be returned. Fixes nodejs#7273 Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
Clarifies that emitter.listener() returns a copy, not a reference Resolves issue nodejs#9022 Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
per: nodejs/node-v0.x-archive#14596 1. document that a runtime error will occur if you attempt to unshift after the end event 2. document that calling read after the end event will return null and will not trigger a runtime error Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
Minor clarifications around Readable._read and Readable.push to make their implementation/usage easier to understand. nodejs/node-v0.x-archive#14124 (comment) Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
Per nodejs/node-v0.x-archive#14604, Document that performing an `unshift` during a read can have unexpected results. Following the `unshift` with a `push('')` resets the reading state appropriately. Also indicate that doing an `unshift` during a read is not optimal and should be avoided. Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
per nodejs/node-v0.x-archive#14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point. Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
Per nodejs/node-v0.x-archive#25635 (comment) Additional refinement to the clarification on the `readable` event Reviewed-By: James M Snell <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
| @@ -801,6 +801,10 @@ on Unix systems, it never was. | |||
|
|
|||
| Returns a new ReadStream object (See `Readable Stream`). | |||
|
|
|||
| Be aware that, unlike the default value set for `highWaterMark` on a | |||
| readable stream(16kb), the stream returned by this method has a | |||
There was a problem hiding this comment.
Space before paren? Also, isn't it more common (and correct) to write it as 16 kB?
|
I don't really care for the typo fixes in comments but whatever. LGTM sans the two things I pointed out. |
Additional edits based on Ben's feedback
|
LGTM |
|
Just as a clarification, would you prefer that I land this as separate commits or squash them down and list each of the originals in the commit message? |
jasnell
added a commit
that referenced
this pull request
Aug 5, 2015
* doc: improve http.abort description * doc: mention that mode is ignored if file exists * docs: Fix default options for fs.createWriteStream() * Documentation update about Buffer initialization * doc: add a note about readable in flowing mode * doc: Document http.request protocol option * doc, comments: Grammar and spelling fixes * updated documentation for fs.createReadStream * Update child_process.markdown, spelling * doc: Clarified read method with specified size argument. * docs:events clarify emitter.listener() behavior * doc: two minor stream doc improvements * doc: clarify Readable._read and Readable.push * doc: stream.unshift does not reset reading state * doc: readable event clarification * doc: additional refinement to readable event Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ben Noorduis <[email protected]> PR-URL: #2302
|
Landed in 936c9ff |
|
applied the new |
|
+1. It would be trivial to cherry pick 936c9ff onto v3.x but agreed, this one is a low priority. |
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.
Cherrypicked commits from nodejs/node-v0.x-archive#25635
These include a handful of doc and comment fixes that landed in v0.12. Some of the commits had to be updated slightly to land.