doc: improvements to console.markdown copy #5225
Conversation
| @@ -9,8 +9,8 @@ The module exports two specific components: | |||
|
|
|||
| * A `Console` class with methods such as `console.log()`, `console.error()` and | |||
| `console.warn()` that can be used to write to any Node.js stream. | |||
| * A global `console` instance configured to write to `stdout` and `stderr`. | |||
| Because this object is global, it can be used without calling | |||
| * A global `console` instance configured to write to process `stdout` and | |||
There was a problem hiding this comment.
Maybe this should instead be:
... to write to `process.stdout` and `process.stderr`.
There was a problem hiding this comment.
Yep, I thought so too, but was waiting for this comment 😄
mscdex
added
doc
| `require('console')`. | ||
| * A global `console` instance configured to write to [`process.stdout`][] and | ||
| [`process.stderr`][]. Because this object is global, it can be used without | ||
| calling `require('console')`. |
There was a problem hiding this comment.
Hmm, multiple places in this file refer to the standard output streams as just stdout, stderr. I think it's better to keep this paragraph unchanged for consistency.
There was a problem hiding this comment.
@mscdex your thoughts? I agree with both of you, to say, so not sure. From one point, it's OK to use stdout or "process stdout" because, it's how it is. Other point is let people understand that global console uses process.stdout and process.stderr Writable streams. Both points are good to me.
There was a problem hiding this comment.
I guess I don't really mind either way, as long as it's all consistent.
There was a problem hiding this comment.
@mscdex @silverwind Fixed.
Fix missing links. Fix styling of printf() - once #5073 lands, link to man page will be auto-generated. Fix several typos.
|
LGTM |
1 similar comment
|
LGTM |
|
Landed in fb502ef. |
MylesBorins
added
land-on-v4.x
and removed
doc
Fix missing links. Fix styling of printf() - once #5073 lands, link to man page will be auto-generated. Fix several typos.