doc: general improvements to tty.md #6931
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jasnell
added
doc
| @@ -2,13 +2,19 @@ | |||
|
|
|||
| Stability: 2 - Stable | |||
|
|
|||
| The `tty` module houses the `tty.ReadStream` and `tty.WriteStream` classes. In | |||
| most cases, you will not need to use this module directly. | |||
| The `tty` modules provides the `tty.ReadStream` and `tty.WriteStream` classes. | |||
|
@thefourtheye ... nits addressed! |
|
Ping @thefourtheye |
|
Seems fine to me if it has any rough definition of a TTY. (Even just "A Terminal".) |
|
added very quick edit equating TTY = text terminal |
|
@nodejs/documentation ... can I please get a final review on this one! |
| * `fd` {number} A numeric file descriptor | ||
|
|
||
| The `tty.isatty()` method returns `true` if the given `fd` is associated with | ||
| a TTY; `false` otherwise. |
There was a problem hiding this comment.
Writing true if X; false otherwise.` always sort of irked me.
|
LGTM |
| `tty.ReadStream` and both `process.stdout` and `process.stderr` will, by | ||
| default be instances of `tty.WriteStream`. The preferred method of determining | ||
| whether Node.js is being run within a TTY context is to check the boolean | ||
| `process.stdout.isTTY` property: |
There was a problem hiding this comment.
Note: this won't be boolean if stdout isn't a TTY instance, instead it will be undefined.
|
LGTM with a nit |
|
Tweaked a bit to address those nits. Landing. |
jasnell
added a commit
that referenced
this pull request
May 27, 2016
PR-URL: #6931 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
|
Landed in 5d2c0ac |
Fishrock123
pushed a commit
to Fishrock123/node
that referenced
this pull request
May 30, 2016
PR-URL: nodejs#6931 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
rvagg
pushed a commit
that referenced
this pull request
Jun 2, 2016
PR-URL: #6931 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Affected core subsystem(s)
doc (tty)
Description of change
General improvements to tty.md
@nodejs/documentation