TTY: Document WriteStream.cursorTo and others by ur0 · Pull Request #22893 · nodejs/node

ur0 · 2018-09-17T08:47:13Z

This adds documentation for the following WriteStream instance methods:

cursorTo
moveCursor
clearLine
clearScreenDown
getWindowSize

Checklist

documentation is changed or added
commit message follows commit guidelines

Adds documentation for the following WriteStream instance methods: - cursorTo - moveCursor - clearLine - clearScreenDown - getWindowSize Fixes nodejs#9853.

vsemozhetbyt

Hi @ur0. Thank you for an effort to improve the docs!

I do not know if these methods are intended to be documented but in case they do, I've mentioned some nits that can be fixed)

vsemozhetbyt · 2018-09-17T21:11:16Z

doc/api/tty.md

+* `x` {number}
+* `y` {number}
+
+`writeStream.cursorTo` moves this `WriteStream`'s cursor to the specified


`writeStream.cursorTo` -> `writeStream.cursorTo()` as per our doc/STYLE_GUIDE.md. The same for the method mentions below.

vsemozhetbyt · 2018-09-17T21:13:05Z

doc/api/tty.md

+`writeStream.cursorTo` moves this `WriteStream`'s cursor to the specified
+position.
+
+### writeStream.moveCursor(dx, dy)


Doc sections need to be ABC-sorted by their headings.

vsemozhetbyt · 2018-09-17T21:19:04Z

doc/api/tty.md

+<!-- YAML
+added: v0.7.7
+-->
+* Returns: {array}


{array} -> {Array} (non-primitive types are uppercased).
Or maybe, as we know the array's elements type, we can make this {number[]}.

vsemozhetbyt · 2018-09-17T21:25:02Z

doc/api/tty.md

+-->
+* Returns: {array}
+
+`writeStream.getWindowSize` returns the size of the [TTY]() corresponding


It seems the link should be [TTY](tty.html) or [TTY](#tty_tty) here and below.

vsemozhetbyt · 2018-09-17T21:25:25Z

doc/api/tty.md

+
+`writeStream.getWindowSize` returns the size of the [TTY]() corresponding
+to this `WriteStream`. The array is of the type `[numColumns, numRows]`
+where `numColumns` and `numRows` represents the number of columns and rows


represents -> represent.

vsemozhetbyt · 2018-09-17T21:29:25Z

cc @nodejs/documentation

ur0 · 2018-09-18T03:50:35Z

Thanks @vsemozhetbyt! I’ll fix the issues in a bit.

addaleax · 2018-09-24T21:00:48Z

ping @ur0 … anything we can help with? :)

- Adds missing parens in function names - Changes `array` to `number[]` - Sorts headers - Adds missing link

ur0 · 2018-09-25T08:56:25Z

Sorry for the delay, and thanks for the offer @addaleax!

Just fixed all of the nits. CC @vsemozhetbyt @nodejs/documentation for a review.

jasnell

Looks like CI failed so that'll need a look but otherwise LGTM

vsemozhetbyt · 2018-09-25T16:10:37Z

doc/api/tty.md

+where `numColumns` and `numRows` represent the number of columns and rows
+in the corresponding [TTY](tty.html).
+
 ## tty.isatty(fd)


It seems this section should be the last one)

vsemozhetbyt · 2018-09-25T16:17:59Z

doc/api/tty.md

 Use the `NODE_DISABLE_COLORS` environment variable to enforce this function to
 always return 1.

+## writeStream.getWindowSize()


## -> ###.

vsemozhetbyt · 2018-09-25T16:20:55Z

doc/api/tty.md

+-->
+* Returns: {number[]}
+
+`writeStream.getWindowSize()` returns the size of the [TTY](tty.html) corresponding


This line exceeds 80 characters limit (linter fails here).

vsemozhetbyt · 2018-09-25T16:23:55Z

@ur0 Thank you for the fixes and patience. Just a few nits remain to be addressed.

ur0 · 2018-10-05T05:57:06Z

@vsemozhetbyt all done, hopefully.

vsemozhetbyt · 2018-10-05T22:06:46Z

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1131/

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>

vsemozhetbyt · 2018-10-05T22:39:05Z

Landed in 2ba19ff
(with nit fixed: ## tty.isatty(fd) level and position is restored).

Thank you!

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>

TTY: Document WriteStream.cursorTo and others

2621840

Adds documentation for the following WriteStream instance methods: - cursorTo - moveCursor - clearLine - clearScreenDown - getWindowSize Fixes nodejs#9853.

nodejs-github-bot added doc Issues and PRs related to the documentations. tty Issues and PRs related to the tty subsystem. labels Sep 17, 2018

vsemozhetbyt reviewed Sep 17, 2018

View reviewed changes

TTY: Fix nits in WriteStream documentation

632ba5a

- Adds missing parens in function names - Changes `array` to `number[]` - Sorts headers - Adds missing link

jasnell approved these changes Sep 25, 2018

View reviewed changes

vsemozhetbyt approved these changes Sep 25, 2018

View reviewed changes

vsemozhetbyt reviewed Sep 25, 2018

View reviewed changes

Reorder sections, fix line overflowing and header levels

c8ac64d

vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 5, 2018

vsemozhetbyt closed this Oct 5, 2018

targos mentioned this pull request Oct 7, 2018

Release proposal: v10.12.0 #23313

Merged

This was referenced Oct 11, 2018

2018-10-10 Version 10.12.0 (Current) @targos beevelop/docker-nodejs#228

Closed

2018-10-10 Version 10.12.0 (Current) @targos beevelop/docker-android-nodejs#243

Closed

2018-10-10 Version 10.12.0 (Current) @targos beevelop/docker-nodejs#229

Closed

reyronald mentioned this pull request Feb 10, 2019

Add cursorTo & clearLine to streams facebook/flow#7082

Closed

Uh oh!

Conversation

ur0 commented Sep 17, 2018

Checklist

Uh oh!

vsemozhetbyt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt commented Sep 17, 2018

Uh oh!

ur0 commented Sep 18, 2018

Uh oh!

addaleax commented Sep 24, 2018

Uh oh!

ur0 commented Sep 25, 2018

Uh oh!

jasnell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt commented Sep 25, 2018

Uh oh!

ur0 commented Oct 5, 2018

Uh oh!

vsemozhetbyt commented Oct 5, 2018

Uh oh!

vsemozhetbyt commented Oct 5, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants