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 <[email protected]> PR-URL: nodejs/node-v0.x-archive#25591
jasnell · Aug 4, 2015 · d3407bc · d3407bc
1 parent 41b8908
commit d3407bc
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
@@ -227,7 +227,9 @@ returns it.  If there is no data available, then it will return
 `null`.
 
 If you pass in a `size` argument, then it will return that many
-bytes.  If `size` bytes are not available, then it will return `null`.
+bytes.  If `size` bytes are not available, then it will return `null`,
+unless we've ended, in which case it will return the data remaining 
+in the buffer.
 
 If you do not specify a `size` argument, then it will return all the
 data in the internal buffer.