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

Make docs for console.time and console.timeEnd more complete #198

Closed
wants to merge 1 commit into from

Conversation

markstos
Copy link
Contributor

console.time() and console.timeEnd() are very closely related. It's useful to reference them both from each other.

@@ -64,11 +64,13 @@ Defaults to `false`. Colors are customizable, see below.

## console.time(label)

Mark a time.
Used to calculate the duration of a specific operation. To start a timer, call the `console.time()` method, giving it a name as only parameter. To stop the timer, and to get the elapsed time in miliseconds, just call the `console.timeEnd()` method, again passing the timer's name as the parameter.
Copy link
Contributor

Choose a reason for hiding this comment

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

Wrap to 80 colums, but otherwise looks much improved.

@sam-github
Copy link
Contributor

Looks good to me, the existing docs were pretty lacking, but can you squash the two commits and wrap to 80 columns?

@markstos
Copy link
Contributor Author

This PR has been updated to squash previous commits and wrap at 80 lines as requested.

@bnoordhuis
Copy link
Member

@markstos LGTM but can you make the commit log conform to what is outlined in CONTRIBUTING.md? Be as descriptive as possible in the first line; 'more complete' is too unspecific.

Bonus points if you turn the references into links. It works like this:

Bla bla [`foo`][#link_to_foo] bla bla.

Where you pluck #link_to_foo from the HTML that make doc writes to out/doc.

`console.time()` and `console.timeEnd()` are very closely related. It's
useful to reference them both from each other.

Previously, console.time() did not mention that it needed to be paired
with a call to console.timeEnd() to be useful, and timeEnd() also failed
to mention that console.time() needed to be called first.

References in both directions have been added.
@markstos
Copy link
Contributor Author

Ben,

I've reformatted the commit message as requested and added the links as
well.

On Tue, Dec 23, 2014 at 10:03 AM, Ben Noordhuis notifications@github.com
wrote:

@markstos https://github.com/markstos LGTM but can you make the commit
log conform to what is outlined in CONTRIBUTING.md? Be as descriptive as
possible in the first line; 'more complete' is too unspecific.

Bonus points if you turn the references into links. It works like this:

Bla bla [foo][#link_to_foo] bla bla.

Where you pluck #link_to_foo from the HTML that make doc writes to
out/doc.

Reply to this email directly or view it on GitHub
#198 (comment).

Mark Stosberg
Senior Systems Engineer
RideAmigos

bnoordhuis pushed a commit that referenced this pull request Dec 23, 2014
`console.time()` and `console.timeEnd()` are very closely related. It's
useful to reference them both from each other.

Previously, console.time() did not mention that it needed to be paired
with a call to console.timeEnd() to be useful, and timeEnd() also failed
to mention that console.time() needed to be called first.

References in both directions have been added.

PR-URL: #198
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
@bnoordhuis
Copy link
Member

Landed in 6af9483, thanks Mark! I reworded the first line to fit in 50 characters.

@bnoordhuis bnoordhuis closed this Dec 23, 2014
@markstos markstos deleted the patch-1 branch December 23, 2014 16:32
@nodejs-github-bot
Copy link
Collaborator

@jasnell
Copy link
Member

jasnell commented Feb 5, 2020

@nodejs/build ... any explanation why we're getting CI runs on old PRs? This is at least the second one I've seen today.

@richardlau
Copy link
Member

@jasnell It's the CI's being started for the security releases and is kind of related to https://github.com/nodejs/github-bot/issues/245 (in that the build jobs are always passing node as the repository name to the bot). There's an added kink in that the jobs and the bot assume the org is nodejs while the security CI's are nodejs-private.

@jasnell
Copy link
Member

jasnell commented Feb 5, 2020

Oy, that's not great. Ok, thanks for the explanation :)

@nodejs-github-bot
Copy link
Collaborator

eti-p-doray added a commit to eti-p-doray/node that referenced this pull request Aug 30, 2024
* Update GetForegroundTaskRunner override

* Fix line ending

---------

Co-authored-by: Etienne Pierre-doray <etiennep@chromium.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants