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: improved stdout markdown consistency in api/console.md #7062

Closed
wants to merge 1 commit into from
Closed

doc: improved stdout markdown consistency in api/console.md #7062

wants to merge 1 commit into from

Conversation

JonathanMontane
Copy link
Contributor

@JonathanMontane JonathanMontane commented May 30, 2016

Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

stdout occurrences in console.time description use inline code.
stdout occurrences in console.timeEnd description use inline code.

`stdout` was written as `inline code` most of the time, except for the `console.time` and `console.timeEnd` functions which made it a bit more tedious to read about.
Now it's always using inline code.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 30, 2016
@mscdex mscdex added the console Issues and PRs related to the console subsystem. label May 30, 2016
@cjihrig
Copy link
Contributor

cjihrig commented May 30, 2016

LGTM

@Fishrock123
Copy link
Contributor

Fishrock123 commented May 30, 2016

@JonathanMontane Thanks for you contribution!

However, it looks like you may have made this PR from the github editor, as your author information shows:

Author: JonathanMontane <JonathanMontane@users.noreply.github.com>

Would you mind doing setting your email to git? (You can also use a name other than your username, if you wish)

$ git config --global user.email "j.random.user@example.com"
$ git config --global user.name "J. Random User"

Then

$ git commit --amend --reset-author
$ git push origin patch-1 --force

Also, some nits about the commit message:

  • Needs a subsystem at the start at the message, such as doc:
  • The description lines are beyond 72 columns long

(We can fix these two on landing, but prefer if you did yourself!)

@eljefedelrodeodeljefe
Copy link
Contributor

LGTM, w/ @Fishrock123 nits addressed.

@jasnell
Copy link
Member

jasnell commented Jun 6, 2016

LGTM. I'll correct the nits while landing

jasnell pushed a commit that referenced this pull request Jun 6, 2016
`stdout` was written as `inline code` most of the time,
except for the `console.time` and `console.timeEnd`
functions which made it a bit more tedious to read about.
Now it's always using inline code.

PR-URL: #7062
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell
Copy link
Member

jasnell commented Jun 6, 2016

Landed in c3e86de with nits addressed

@jasnell jasnell closed this Jun 6, 2016
evanlucas pushed a commit that referenced this pull request Jun 15, 2016
`stdout` was written as `inline code` most of the time,
except for the `console.time` and `console.timeEnd`
functions which made it a bit more tedious to read about.
Now it's always using inline code.

PR-URL: #7062
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@evanlucas evanlucas mentioned this pull request Jun 16, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
console Issues and PRs related to the console subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants