Skip to content
New issue

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

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

Already on GitHub? # to your account

Rewrite Using the User Timing API #21917

Merged
merged 4 commits into from
Oct 31, 2022
Merged

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Oct 28, 2022

Description

This PR rewrites https://developer.mozilla.org/en-US/docs/Web/API/User_Timing_API/Using_the_User_Timing_API.

Motivation

openwebdocs/project#62

Additional details

I ended up completely rewriting this page. I don't think its current structure nor the code examples are particularly useful. It also references stuff on GitHub which I think should be removed. https://github.com/mdn/dom-examples/blob/main/performance-apis/

Related issues and pull requests

#21853 rewrites the corresponding overview page for this API.

@Elchi3 Elchi3 requested a review from a team as a code owner October 28, 2022 16:35
@Elchi3 Elchi3 requested review from wbamberg and removed request for a team October 28, 2022 16:35
@github-actions github-actions bot added the Content:WebAPI Web API docs label Oct 28, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Oct 28, 2022

Preview URLs

(this comment was updated 2022-10-31 08:33:16.738728)

Copy link
Contributor

@teoli2003 teoli2003 left a comment

Choose a reason for hiding this comment

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

A few minor changes. There is also a flaw, a broken link, but wasn't able to determine if this was intended (the document is coming) or if it was removed (and then the sentence should be removed).
Capture d’écran 2022-10-31 à 08 19 43


A _live_ version of the examples is available on [GitHub](https://mdn.github.io/dom-examples/performance-apis/Using_the_User_Timing_API.html), as is the [source code](https://github.com/mdn/dom-examples/blob/main/performance-apis/Using_the_User_Timing_API.html). Pull requests, enhancement requests and [bug reports](https://github.com/mdn/dom-examples/issues) are welcome.
## What is User Timing?
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## What is User Timing?
## What is a user timing?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think "User Timing" is better. It refers to the name of the API.

Elchi3 and others added 3 commits October 31, 2022 09:21
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
…index.md

Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
@Elchi3
Copy link
Member Author

Elchi3 commented Oct 31, 2022

Thanks for the review, @teoli2003! I fixed the flaw and applied all but one of your suggestions :)

@teoli2003 teoli2003 merged commit c99c684 into mdn:main Oct 31, 2022
@Elchi3 Elchi3 deleted the using-user-timing branch October 31, 2022 08:38
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 1, 2023
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants