Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cherrypick v0.12 doc updates #2302

Closed
wants to merge 17 commits into from
Closed

Cherrypick v0.12 doc updates #2302

wants to merge 17 commits into from

Commits on Aug 4, 2015

  1. doc: improve http.abort description 

    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/node-v0.x-archive#25591
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    b259be7 View commit details
    Browse the repository at this point in the history

  2. doc: mention that mode is ignored if file exists 

    per: nodejs/node-v0.x-archive#6847

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    60b4239 View commit details
    Browse the repository at this point in the history

  3. docs: Fix default options for fs.createWriteStream() 

    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)
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    f32f822 View commit details
    Browse the repository at this point in the history

  4. Documentation update about Buffer initialization 

    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
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    e603452 View commit details
    Browse the repository at this point in the history

  5. doc: add a note about readable in flowing mode 

    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 <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    66047a5 View commit details
    Browse the repository at this point in the history

  6. doc: Document http.request protocol option 

    Per: nodejs/node-v0.x-archive@16f5476

Originally contributed by: @scop

Original commit patch did not apply cleanly
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    93c489e View commit details
    Browse the repository at this point in the history

  7. doc, comments: Grammar and spelling fixes 

    Per: nodejs/node-v0.x-archive@5ccb429

Originally contributed by @scop

Original commit patch did not apply cleanly
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    46396cc View commit details
    Browse the repository at this point in the history

  8. updated documentation for fs.createReadStream 

    per: nodejs/node-v0.x-archive@59c67fe

Originally contributed by @skypjack

Original commit patch did not land cleanly
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    4a8fbf3 View commit details
    Browse the repository at this point in the history

  9. Update child_process.markdown, spelling 

    'the' to 'then'

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @jalexanderfox @jasnell
    jalexanderfox authored and jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    41b8908 View commit details
    Browse the repository at this point in the history

  10. doc: Clarified read method with specified size argument. 

    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 <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @plafer @jasnell
    plafer authored and jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    d3407bc View commit details
    Browse the repository at this point in the history

  11. docs:events clarify emitter.listener() behavior 

    Clarifies that emitter.listener() returns a copy, not a reference
Resolves issue nodejs#9022

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @bsteephenson @jasnell
    bsteephenson authored and jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    c6d7974 View commit details
    Browse the repository at this point in the history

  12. doc: two minor stream doc improvements 

    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 <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    034b4d5 View commit details
    Browse the repository at this point in the history

  13. doc: clarify Readable._read and Readable.push 

    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 <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @fresheneesz @jasnell
    fresheneesz authored and jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    d0b54ea View commit details
    Browse the repository at this point in the history

  14. doc: stream.unshift does not reset reading state 

    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 <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    de79062 View commit details
    Browse the repository at this point in the history

  15. doc: readable event clarification 

    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 <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    3d6d8e9 View commit details
    Browse the repository at this point in the history

  16. doc: additional refinement to readable event 

    Per nodejs/node-v0.x-archive#25635 (comment)

Additional refinement to the clarification on the `readable` event

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs/node-v0.x-archive#25591
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    2fa7736 View commit details
    Browse the repository at this point in the history

  17. doc: minor edits based on feedback 

    Additional edits based on Ben's feedback
    @jasnell
    jasnell committed Aug 4, 2015
    Configuration menu
    Copy the full SHA
    c071d7a View commit details
    Browse the repository at this point in the history