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

doc: several documentation improvements #25635

Closed
wants to merge 7 commits into from

Commits on Jun 29, 2015

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

    Clarifies that emitter.listener() returns a copy, not a reference
    Resolves issue nodejs#9022
    bsteephenson authored and jasnell committed Jun 29, 2015
    Configuration menu
    Copy the full SHA
    b5c2933 View commit details
    Browse the repository at this point in the history

Commits on Jul 1, 2015

  1. 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
    jasnell committed Jul 1, 2015
    Configuration menu
    Copy the full SHA
    ec67d78 View commit details
    Browse the repository at this point in the history
  2. 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)
    fresheneesz authored and jasnell committed Jul 1, 2015
    Configuration menu
    Copy the full SHA
    003c1b2 View commit details
    Browse the repository at this point in the history

Commits on Jul 6, 2015

  1. Update util.markdown

    Fix for nodejs#25559 (Typo in example of util.deprecate() documentation)
    danielrentz authored and jasnell committed Jul 6, 2015
    Configuration menu
    Copy the full SHA
    6528aed View commit details
    Browse the repository at this point in the history
  2. 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.
    jasnell committed Jul 6, 2015
    Configuration menu
    Copy the full SHA
    b3a8fec View commit details
    Browse the repository at this point in the history
  3. 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.
    jasnell committed Jul 6, 2015
    Configuration menu
    Copy the full SHA
    970e2f1 View commit details
    Browse the repository at this point in the history

Commits on Jul 9, 2015

  1. doc: additional refinement to readable event

    Per nodejs#25635 (comment)
    
    Additional refinement to the clarification on the `readable` event
    jasnell committed Jul 9, 2015
    Configuration menu
    Copy the full SHA
    4ed55ff View commit details
    Browse the repository at this point in the history