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.

Sign up for GitHub

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

Jump to bottom

Update Element Timing API pages #22846

Merged
merged 11 commits into from
Jan 3, 2023
Merged

Update Element Timing API pages #22846

merged 11 commits into from
Jan 3, 2023

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Dec 9, 2022

Description

This PR updates pages for the Element Timing API. The main page is https://developer.mozilla.org/en-US/docs/Web/API/PerformanceElementTiming. The overview page https://developer.mozilla.org/en-US/docs/Web/API/Element_timing_API is redirected to the main interface page per our plan to document Performance APIs as a single group.

Motivation

openwebdocs/project#62

Additional details

  • Adds missing docs for Element.elementTiming (reflection of the HTML attribute)
  • Uses "type" and "buffered" in observe calls
  • Removes unnecessary note box usage on the PerformanceElementTiming subpages. (prime example how I think notes should not be used: This shouldn't be note-worthy, this is just normal explanatory text about what the example code does).
  • Adds cross-origin info to the renderTime page.

Related issues and pull requests

None.

@Elchi3 Elchi3 requested review from a team as code owners December 9, 2022 16:09
@Elchi3 Elchi3 requested review from wbamberg, estelle and bsmth and removed request for a team December 9, 2022 16:09
@github-actions github-actions bot added Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs labels Dec 9, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2022 •
edited
Loading

Preview URLs (15 pages)
Flaws (10)

Note! 13 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/Element
Title: Element
Flaw count: 9

  • macros:
    • /en-US/docs/Web/API/Element/getBoxQuads does not exist
    • /en-US/docs/Web/API/Element/select_event redirects to /en-US/docs/Web/API/HTMLInputElement/select_event
    • /en-US/docs/Web/API/HTMLElement/oncopy redirects to /en-US/docs/Web/API/HTMLElement/copy_event
    • /en-US/docs/Web/API/HTMLElement/oncut redirects to /en-US/docs/Web/API/HTMLElement/cut_event
    • /en-US/docs/Web/API/HTMLElement/onpaste redirects to /en-US/docs/Web/API/HTMLElement/paste_event
  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!

URL: /en-US/docs/Web/API/PerformanceElementTiming/element
Title: PerformanceElementTiming.element
Flaw count: 1

  • macros:
    • wrong xref macro used (consider changing which macro you use)

(comment last updated: 2023-01-03 08:52:46)

@Elchi3 Elchi3 mentioned this pull request Dec 9, 2022
Merged
estelle
estelle reviewed Dec 10, 2022
View reviewed changes
Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

two questions. one issue (repeated multiple times)

files/en-us/web/api/performanceelementtiming/id/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceelementtiming/identifier/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceelementtiming/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceelementtiming/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceelementtiming/intersectionrect/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceelementtiming/loadtime/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceelementtiming/url/index.md Outdated Show resolved Hide resolved
@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@Elchi3
Copy link
Member Author

Elchi3 commented Dec 16, 2022

I've addressed the review comments and resolved the merge conflicts.

@Elchi3 Elchi3 requested a review from estelle December 21, 2022 10:03
@bsmth
Copy link
Member

bsmth commented Jan 2, 2023

Taking a look now 👀

bsmth
bsmth approved these changes Jan 3, 2023
View reviewed changes
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Thanks @Elchi3 👍🏻

@bsmth bsmth merged commit 68d50e9 into mdn:main Jan 3, 2023
@Elchi3 Elchi3 deleted the element-timing branch January 3, 2023 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bsmth bsmth bsmth approved these changes

@wbamberg wbamberg Awaiting requested review from wbamberg wbamberg is a code owner automatically assigned from mdn/yari-content-web-api

@estelle estelle Awaiting requested review from estelle

Assignees
No one assigned
Labels
Content:HTML Hypertext Markup Language docs Content:WebAPI Web API docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Elchi3 @bsmth @estelle