doc: improvements to console.markdown copy #5225
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
| @@ -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. |
silverwind
pushed a commit
that referenced
this pull request
Feb 17, 2016
Fix missing links. Fix styling of printf() - once #5073 lands, link to man page will be auto-generated. Fix several typos. PR-URL: #5225 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: James M Snell <[email protected]>
rvagg
pushed a commit
that referenced
this pull request
Feb 18, 2016
Fix missing links. Fix styling of printf() - once #5073 lands, link to man page will be auto-generated. Fix several typos. PR-URL: #5225 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: James M Snell <[email protected]>
MylesBorins
added
land-on-v4.x
and removed
doc
MylesBorins
pushed a commit
that referenced
this pull request
Feb 22, 2016
Fix missing links. Fix styling of printf() - once #5073 lands, link to man page will be auto-generated. Fix several typos. PR-URL: #5225 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: James M Snell <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 22, 2016
Fix missing links. Fix styling of printf() - once #5073 lands, link to man page will be auto-generated. Fix several typos. PR-URL: #5225 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: James M Snell <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 2, 2016
Fix missing links. Fix styling of printf() - once #5073 lands, link to man page will be auto-generated. Fix several typos. PR-URL: #5225 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: James M Snell <[email protected]>
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.
Fix missing links. Fix styling of printf() - once #5073 lands, link to man page will be auto-generated. Fix several typos.