doc: fix two doc errors in stream and process
authorJeremiah Senkpiel <fishrock123@rocketmail.com>
Tue, 25 Aug 2015 21:19:18 +0000 (17:19 -0400)
committerJeremiah Senkpiel <fishrock123@rocketmail.com>
Tue, 15 Sep 2015 01:50:58 +0000 (21:50 -0400)
`process.stdout` always blocks as of
20176a98416353d4596900793f739d5ebf4f0ee1

`WritableState.buffer` is `getBuffer()` as of
91586661c983f45d650644451df73c8649a8d459

PR-URL: https://github.com/nodejs/node/pull/2549
Reviewed-By: Alexis Campailla <orangemocha@nodejs.org>
Reviewed-By: Evan Lucas <evanlucas@me.com>
doc/api/process.markdown
doc/api/stream.markdown

index c139384..031e86b 100644 (file)
@@ -256,13 +256,7 @@ For example, a `console.log` equivalent could look like this:
 
 `process.stderr` and `process.stdout` are unlike other streams in Node.js in
 that they cannot be closed (`end()` will throw), they never emit the `finish`
-event and that writes are usually blocking.
-
-- They are blocking in the case that they refer to regular files or TTY file
-  descriptors.
-- In the case they refer to pipes:
-  - They are blocking in Linux/Unix.
-  - They are non-blocking like other streams in Windows.
+event and that writes are always blocking.
 
 To check if Node.js is being run in a TTY context, read the `isTTY` property
 on `process.stderr`, `process.stdout`, or `process.stdin`:
index a55098c..4dfc36e 100644 (file)
@@ -1440,8 +1440,8 @@ var transform = new stream.Transform({
 <!--type=misc-->
 
 Both Writable and Readable streams will buffer data on an internal
-object called `_writableState.buffer` or `_readableState.buffer`,
-respectively.
+object which can be retrieved from `_writableState.getBuffer()` or 
+`_readableState.buffer`, respectively.
 
 The amount of data that will potentially be buffered depends on the
 `highWaterMark` option which is passed into the constructor.