Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

doc: apply multiple doc updates from master to v0.12 #25591

Closed
wants to merge 20 commits into from

Commits on Jun 29, 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#25565
    jasnell committed Jun 29, 2015
    Configuration menu
    Copy the full SHA
    88153f6 View commit details
    Browse the repository at this point in the history
  2. doc: mention that mode is ignored if file exists

    per: nodejs#6847
    
    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25565
    jasnell committed Jun 29, 2015
    Configuration menu
    Copy the full SHA
    0209501 View commit details
    Browse the repository at this point in the history
  3. doc: add CleartextStream deprecation notice

    Per: nodejs#8017
    
    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25565
    jasnell committed Jun 29, 2015
    Configuration menu
    Copy the full SHA
    e9bf57e View commit details
    Browse the repository at this point in the history
  4. docs: Fix default options for fs.createWriteStream()

    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
    chrisneave authored and jasnell committed Jun 29, 2015
    Configuration menu
    Copy the full SHA
    8c357a6 View commit details
    Browse the repository at this point in the history
  5. Documentation update about Buffer initialization

    fixes nodejs#7230
    
    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25565
    sarathms authored and jasnell committed Jun 29, 2015
    Configuration menu
    Copy the full SHA
    d8933f3 View commit details
    Browse the repository at this point in the history
  6. doc: fix line wrapping in buffer.markdown

    Fix the line wrapping in buffer.markdown
    
    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25565
    jasnell committed Jun 29, 2015
    Configuration menu
    Copy the full SHA
    8910775 View commit details
    Browse the repository at this point in the history
  7. doc: add a note about readable in flowing mode

    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
    jasnell committed Jun 29, 2015
    Configuration menu
    Copy the full SHA
    206d0c3 View commit details
    Browse the repository at this point in the history

Commits on Jul 9, 2015

  1. doc: Document http.request protocol option

    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25592
    scop authored and jasnell committed Jul 9, 2015
    Configuration menu
    Copy the full SHA
    b72329e View commit details
    Browse the repository at this point in the history
  2. doc, comments: Grammar and spelling fixes

    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25592
    scop authored and jasnell committed Jul 9, 2015
    Configuration menu
    Copy the full SHA
    cd80bc8 View commit details
    Browse the repository at this point in the history
  3. updated documentation for fs.createReadStream

    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25592
    skypjack authored and jasnell committed Jul 9, 2015
    Configuration menu
    Copy the full SHA
    eb5f00e View commit details
    Browse the repository at this point in the history
  4. Update child_process.markdown, spelling

    'the' to 'then'
    
    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25592
    jalexanderfox authored and jasnell committed Jul 9, 2015
    Configuration menu
    Copy the full SHA
    0fc3883 View commit details
    Browse the repository at this point in the history
  5. 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#25592
    plafer authored and jasnell committed Jul 9, 2015
    Configuration menu
    Copy the full SHA
    707be4d View commit details
    Browse the repository at this point in the history

Commits on Jul 10, 2015

  1. 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#25635
    bsteephenson authored and jasnell committed Jul 10, 2015
    Configuration menu
    Copy the full SHA
    08dd394 View commit details
    Browse the repository at this point in the history
  2. doc: two minor stream doc improvements

    per: nodejs#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#25635
    jasnell committed Jul 10, 2015
    Configuration menu
    Copy the full SHA
    d33c172 View commit details
    Browse the repository at this point in the history
  3. doc: clarify Readable._read and Readable.push

    Minor clarifications around Readable._read and Readable.push
    to make their implementation/usage easier to understand.
    
    nodejs#14124 (comment)
    
    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25635
    fresheneesz authored and jasnell committed Jul 10, 2015
    Configuration menu
    Copy the full SHA
    00551e7 View commit details
    Browse the repository at this point in the history
  4. Update util.markdown

    Fix for nodejs#25559 (Typo in example of util.deprecate() documentation)
    
    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25635
    danielrentz authored and jasnell committed Jul 10, 2015
    Configuration menu
    Copy the full SHA
    571ce9a View commit details
    Browse the repository at this point in the history
  5. doc: stream.unshift does not reset reading state

    Per nodejs#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#25635
    jasnell committed Jul 10, 2015
    Configuration menu
    Copy the full SHA
    0b5f82d View commit details
    Browse the repository at this point in the history
  6. doc: readable event clarification

    per nodejs#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#25635
    jasnell committed Jul 10, 2015
    Configuration menu
    Copy the full SHA
    4a15b9f View commit details
    Browse the repository at this point in the history
  7. doc: additional refinement to readable event

    Per nodejs#25635 (comment)
    
    Additional refinement to the clarification on the `readable` event
    
    Reviewed-By: James M Snell <jasnell@gmail.com>
    PR-URL: nodejs#25635
    jasnell committed Jul 10, 2015
    Configuration menu
    Copy the full SHA
    cf3e59d View commit details
    Browse the repository at this point in the history

Commits on Aug 4, 2015

  1. Configuration menu
    Copy the full SHA
    67dee32 View commit details
    Browse the repository at this point in the history