This repository has been archived by the owner on Apr 22, 2023. It is now read-only.
doc: a handful of doc improvements #25565
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.
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'.
|
@joyent/node-tsc ... can I get a quick review on these doc changes? |
| @@ -64,7 +64,7 @@ It can be constructed in a variety of ways. | |||
|
|
|||
| Allocates a new buffer of `size` octets. Note, `size` must be no more than | |||
| [kMaxLength](smalloc.html#smalloc_smalloc_kmaxlength). Otherwise, a `RangeError` | |||
| will be thrown here. | |||
| will be thrown here. Unlike `ArrayBuffers`, the underlying memory for buffers is not initialized. So the contents of a newly created `Buffer` is unknown. Use `buf.fill(0)`to initialize a buffer to zeroes. | |||
There was a problem hiding this comment.
Reads well. I'd suggest word wrapping the same as above.
|
One nit. Otherwise LGTM. |
Fix the line wrapping in buffer.markdown
|
@trevnorris ... better? (I'll squash down the commits before landing) |
|
looks great. |
Original: nodejs#8682 Slightly modified version of the original PR (nodejs#8682) to add appropriate line wrapping and fix a couple of grammar nits.
jasnell
pushed a commit
that referenced
this pull request
Jun 26, 2015
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'. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25565
jasnell
added a commit
that referenced
this pull request
Jun 26, 2015
Fix the line wrapping in buffer.markdown Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25565
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jun 29, 2015
Per nodejs#4409, the documentation on http.abort is a bit lacking. This provides a slight improvement. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25565
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jun 29, 2015
per: nodejs#6847 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25565
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jun 29, 2015
Per: nodejs#8017 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25565
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jun 29, 2015
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'. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25565
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jun 29, 2015
fixes nodejs#7230 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25565
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jun 29, 2015
Fix the line wrapping in buffer.markdown Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25565
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jun 29, 2015
Original: nodejs#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 <jasnell@gmail.com> PR-URL: nodejs#25565
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Four separate doc improvements covering various issues. I've bundled these up
as separate commits within a single PR to make it easier to land.