lib: Improve readability of help text in node --help#23016
Conversation
addaleax commented Sep 22, 2018
I think the current text was intentional; reading from stdin is the default when no other file name is provided, and if stdin is a TTY we enter interactive mode? |
It seems the "reading from stdin" is wider than "interactive mode" (it may be a command chain), so this is a note about a partial case, not the definition of "default", and the semicolon seems valid. |
gireeshpunathil commented Sep 22, 2018
ah! I see it now, thanks for the clarification. |
addaleax commented Sep 22, 2018
@gireeshpunathil That doesn’t mean we can’t improve here … I agree that this is not immediately obvious. Maybe we could change it to something like |
gireeshpunathil commented Sep 22, 2018
I reworded the help message for better readability, PTAL. |
gireeshpunathil changed the title node --help
gireeshpunathil commented Sep 25, 2018
Re-run of failing node-test-commit-linux-containered and node-test-commit-linux/ |
gireeshpunathil commented Sep 28, 2018
rebased and started a new CI: https://ci.nodejs.org/job/node-test-pull-request/17491/ |
gireeshpunathil commented Sep 28, 2018
only one known failure under |
gireeshpunathil added the cli 
modified the `-` CLI option help text for improved readability. PR-URL: nodejs#23016 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
gireeshpunathilforce-pushed the default branch from ac93f91 to 0f78b9aCompare
modified the `-` CLI option help text for improved readability. PR-URL: #23016 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
modified the `-` CLI option help text for improved readability. PR-URL: #23016 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
9 participants
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes