doc: documentation for WriteStream.cursorTo and other TTY methods #9853
Labels
doc
Issues and PRs related to the documentations.
good first issue
Issues that are suitable for first-time contributors.
tty
Issues and PRs related to the tty subsystem.
Comments
Old issue |
mscdex
added
doc
|
I think we should be able to issue runtime deprecations for these. There shouldn't be a reason to document them. |
|
We should at least remove our own use of |
|
@dcposch @Fishrock123 Should this remain open? |
|
@nodejs/documentation @nodejs/process Anyone want to document |
Trott
added
the
good first issue
ur0
added a commit
to ur0/node
that referenced
this issue
Sep 17, 2018
Adds documentation for the following WriteStream instance methods: - cursorTo - moveCursor - clearLine - clearScreenDown - getWindowSize Fixes nodejs#9853.
2 tasks
targos
pushed a commit
that referenced
this issue
Oct 6, 2018
Adds documentation for the following `WriteStream` instance methods: - `WriteStream.clearLine()` - `WriteStream.clearScreenDown()` - `WriteStream.cursorTo()` - `WriteStream.getWindowSize()` - `WriteStream.moveCursor()` PR-URL: #22893 Fixes: #9853 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
targos
pushed a commit
that referenced
this issue
Oct 7, 2018
Adds documentation for the following `WriteStream` instance methods: - `WriteStream.clearLine()` - `WriteStream.clearScreenDown()` - `WriteStream.cursorTo()` - `WriteStream.getWindowSize()` - `WriteStream.moveCursor()` PR-URL: #22893 Fixes: #9853 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
jasnell
pushed a commit
that referenced
this issue
Oct 17, 2018
Adds documentation for the following `WriteStream` instance methods: - `WriteStream.clearLine()` - `WriteStream.clearScreenDown()` - `WriteStream.cursorTo()` - `WriteStream.getWindowSize()` - `WriteStream.moveCursor()` PR-URL: #22893 Fixes: #9853 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Even if they're deprecated and we're supposed to use the
readlinemodule now, the docs should say that, right?Currently, the docs don't list
process.stdout.cursorToand related functions at all.Popular modules, as well as Node itself, still use them:
node-progress module
node debugger
Here's the full list of functions I'm referring to:
tty.js:92
I think it would reduce confusion if we at least mentioned these in the
processorstreamdocs.The text was updated successfully, but these errors were encountered: