tty: clarify that tty.setRawMode() has moved to process.stdin

Technically saying `tty.ReadStream#setRawMode()` is correct, but since a typical use cannot instantiate `tty.ReadStream` themselves, and 99% of the time the only instance is `process.stdin`, then a little clarification seemed necessary.
nodejs · Mar 29, 2012 · 304f1fc · 304f1fc
1 parent 6aa7550
commit 304f1fc
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/doc/api/tty.markdown b/doc/api/tty.markdown
@@ -24,7 +24,8 @@ terminal.
 
 ## tty.setRawMode(mode)
 
-Deprecated. Use `tty.ReadStream#setRawMode()` instead.
+Deprecated. Use `tty.ReadStream#setRawMode()`
+(i.e. `process.stdin.setRawMode()`) instead.
 
 
 ## Class: ReadStream

diff --git a/lib/tty.js b/lib/tty.js
@@ -37,7 +37,7 @@ exports.setRawMode = function(flag) {
   }
   process.stdin.setRawMode(flag);
 };
-module.deprecate('setRawMode', 'Use `tty.ReadStream#setRawMode` instead.');
+module.deprecate('setRawMode', 'Use `process.stdin.setRawMode()` instead.');
 
 
 function ReadStream(fd) {