doc: improvements to console.markdown copy #4428
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
jasnell
added
doc
| @@ -2,29 +2,79 @@ | |||
|
|
|||
| Stability: 2 - Stable | |||
|
|
|||
| The module defines a `Console` class and exports a `console` object. | |||
| The `console` module provides a simple debugging console that is similar, but | |||
| not identical to the JavaScript console mechanism provided by Web browsers. | |||
There was a problem hiding this comment.
Nit: is similar to the JavaScript console mechanism provided by web browsers. No need to say but not identical as that is what similar means.
If you do keep but not identical1, please add a comma after identical.
Also: web rather than Web. Most style guides no longer favor capitalizing Web as far as I know. (Internet vs. internet is a different story.)
|
@Trott ... fixed! |
|
LGTM |
| @@ -2,29 +2,79 @@ | |||
|
|
|||
| Stability: 2 - Stable | |||
|
|
|||
| The module defines a `Console` class and exports a `console` object. | |||
| The `console` module provides a simple debugging console that is similar to the | |||
There was a problem hiding this comment.
It might be useful to say "similar, but not identical to" as we get a decent number of requests for console features that browsers have.
There was a problem hiding this comment.
Heh, I see that you covered that topic a little further down.
|
LGTM |
| For ease of use, `console` is defined as a global object and can be used | ||
| directly without `require`. | ||
| Typically, the distinction between blocking/non-blocking is not important | ||
| unless an application is logging significant amounts to data. High volume |
There was a problem hiding this comment.
should this be "significant amounts of data"?
|
Left a few comments and LGTM |
Several improvements including a few new examples
jasnell
force-pushed
the
doc-console-improvements
branch
from
249461b
to
36766ff
Compare
|
@evanlucas ... nits addressed |
jasnell
added a commit
that referenced
this pull request
Dec 30, 2015
Several improvements including a few new examples PR-URL: #4428 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>
|
Landed in e4c835e |
Fishrock123
pushed a commit
to Fishrock123/node
that referenced
this pull request
Jan 6, 2016
Several improvements including a few new examples PR-URL: nodejs#4428 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>
jasnell
added a commit
that referenced
this pull request
Jan 7, 2016
Several improvements including a few new examples PR-URL: #4428 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>
|
Added to LTS with minor edits to the |
MylesBorins
pushed a commit
that referenced
this pull request
Jan 19, 2016
Several improvements including a few new examples PR-URL: #4428 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>
Merged
scovetta
pushed a commit
to scovetta/node
that referenced
this pull request
Apr 2, 2016
Several improvements including a few new examples PR-URL: nodejs#4428 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>
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.
Several improvements including a few new examples