doc: document Console class #1388
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
JacksonTian
force-pushed
the
doc_console
branch
2 times, most recently
from
081f382
to
7f8f97c
Compare
|
Thanks @benjamingr updated by your review comments. |
| The `console` object is a special instance of `Console` that the output is | ||
| sent to stdout or stderr. | ||
|
|
||
| For easily to use it, `console` is a global object, so you can use it directly. |
There was a problem hiding this comment.
"For ease of use, console is defined as a global object and can be used directly without require."
|
Left some grammar corrections. |
JacksonTian
force-pushed
the
doc_console
branch
from
7f8f97c
to
4477c57
Compare
|
Thanks @silverwind . |
|
|
||
| Stability: 2 - Stable | ||
|
|
||
| The module defines a `Console` class and exports a `console` object. | ||
|
|
||
| The `console` object is a special instance of `Console` that the output is |
There was a problem hiding this comment.
Same as below: "instance of Console whose output"
|
Grammar should be fine once these two 'whose' cases are corrected. |
document Console class to tell user can use it.
JacksonTian
force-pushed
the
doc_console
branch
from
4477c57
to
0926b8f
Compare
|
fixed. @silverwind thanks again. |
|
Thanks! Landed in 2bc3532 |
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.
document Console class to tell user can use it.