aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNathan Rajlich <nathan@tootallnate.net>2012-03-29 13:15:24 -0700
committerNathan Rajlich <nathan@tootallnate.net>2012-03-29 13:15:24 -0700
commit304f1fcf86f38552d483eb69f6ccef331e691753 (patch)
tree2d75cb3f958ebb6ad4bad666d86b68a1f9a46be0 /doc
parent6aa755070a5d89f5adeb6d53e6eea6fbf49a6bb7 (diff)
downloadandroid-node-v8-304f1fcf86f38552d483eb69f6ccef331e691753.tar.gz
android-node-v8-304f1fcf86f38552d483eb69f6ccef331e691753.tar.bz2
android-node-v8-304f1fcf86f38552d483eb69f6ccef331e691753.zip
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.
Diffstat (limited to 'doc')
-rw-r--r--doc/api/tty.markdown3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/tty.markdown b/doc/api/tty.markdown
index 57062945dc..104fb8ca41 100644
--- 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