Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: document Console class #1388

Closed
wants to merge 1 commit into from
Closed

Conversation

JacksonTian
Copy link
Contributor

document Console class to tell user can use it.

@JacksonTian
Copy link
Contributor Author

Thanks @benjamingr updated by your review comments.

@mscdex mscdex added the doc Issues and PRs related to the documentations. label Apr 10, 2015
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"For ease of use, console is defined as a global object and can be used directly without require."

@silverwind
Copy link
Contributor

Left some grammar corrections.

@JacksonTian
Copy link
Contributor Author

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as below: "instance of Console whose output"

@silverwind
Copy link
Contributor

Grammar should be fine once these two 'whose' cases are corrected.

document Console class to tell user can use it.
@JacksonTian
Copy link
Contributor Author

fixed. @silverwind thanks again.

silverwind pushed a commit that referenced this pull request Apr 11, 2015
document Console class to tell user can use it.

PR-URL: #1388
Fixes: #1359
Reviewed-By: Roman Reiss <me@silverwind.io>
@silverwind
Copy link
Contributor

Thanks! Landed in 2bc3532

@silverwind silverwind closed this Apr 11, 2015
@rvagg rvagg mentioned this pull request Apr 11, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants