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

Fix various xref macro calls #28352

Merged
merged 3 commits into from
Aug 4, 2023
Merged

Fix various xref macro calls #28352

merged 3 commits into from
Aug 4, 2023

Conversation

queengooborg
Copy link
Collaborator

This PR fixes various xref macro calls throughout the documentation.

@queengooborg queengooborg requested a review from a team August 2, 2023 20:14
@queengooborg queengooborg requested review from a team as code owners August 2, 2023 20:14
@queengooborg queengooborg requested review from Ryuno-Ki, wbamberg and chrisdavidmills and removed request for a team August 2, 2023 20:14
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:WebAPI Web API docs Content:Other Any docs not covered by another "Content:" label Content:SVG SVG docs labels Aug 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023 •
edited
Loading

Preview URLs (59 pages)
Flaws (191)

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

URL: /en-US/docs/Web/SVG/Attribute/data-*
Title: data-*
Flaw count: 1

  • macros:
    • /en-US/docs/Glossary/camelCase does not exist

URL: /en-US/docs/Web/API/SVG_API
Title: SVG API
Flaw count: 13

  • macros:
    • /en-US/docs/Web/API/SVGFilterPrimitiveStandardAttributes does not exist
    • /en-US/docs/Web/API/SVGHatchElement does not exist
    • /en-US/docs/Web/API/SVGHatchpathElement does not exist
    • /en-US/docs/Web/API/SVGElementInstance does not exist
    • /en-US/docs/Web/API/SVGElementInstanceList does not exist
    • and 8 more flaws omitted

URL: /en-US/docs/Web/API/RTCInboundRtpStreamStats/qpSum
Title: RTCInboundRtpStreamStats: qpSum property
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/RTCReceivedRtpStreamStats/framesDecoded does not exist
    • /en-US/docs/Web/API/RTCSentRtpStreamStats/framesEncoded does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.RTCInboundRtpStreamStats.qpSum

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

  • macros:
    • /en-US/docs/Web/API/Element/getBoxQuads does not exist

URL: /en-US/docs/Web/API/EXT_disjoint_timer_query
Title: EXT_disjoint_timer_query extension
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/EXT_disjoint_timer_query_webgl2 does not exist
    • /en-US/docs/Web/API/GetQueryObject does not exist
    • /en-US/docs/Web/API/GetQueryParameter does not exist

URL: /en-US/docs/Web/API/File
Title: File
Flaw count: 3

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/API/URL/createObjectURL redirects to /en-US/docs/Web/API/URL/createObjectURL_static

URL: /en-US/docs/Web/API/HTMLScriptElement
Title: HTMLScriptElement
Flaw count: 12

  • macros:
    • /en-US/docs/Web/API/HTMLScriptElement/type does not exist
    • /en-US/docs/Web/API/HTMLScriptElement/src does not exist
    • /en-US/docs/Web/API/HTMLScriptElement/event does not exist
    • /en-US/docs/Web/API/HTMLScriptElement/charset does not exist
    • /en-US/docs/Web/API/HTMLScriptElement/async does not exist
    • and 7 more flaws omitted

URL: /en-US/docs/Web/API/Document
Title: Document
Flaw count: 40

  • macros:
    • /en-US/docs/Web/API/HTMLAllCollection does not exist
    • /en-US/docs/Web/API/Document/xmlStandalone does not exist
    • /en-US/docs/Web/API/Document/captureEvents does not exist
    • /en-US/docs/Web/API/Document/getBoxQuads does not exist
    • /en-US/docs/Web/API/Document/releaseEvents does not exist
    • and 35 more flaws omitted

URL: /en-US/docs/Web/API/RTCRemoteOutboundRtpStreamStats/localId
Title: RTCRemoteOutboundRtpStreamStats: localId property
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/RTCSentRtpStreamStats/packetsSent does not exist
    • /en-US/docs/Web/API/RTCSentRtpStreamStats/bytesSent does not exist
  • bad_bcd_queries:
    • No BCD data for query: api.RTCRemoteOutboundRtpStreamStats.localId

URL: /en-US/docs/Web/API/PerformanceEventTiming
Title: PerformanceEventTiming
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/HTMLElement/pointerrawupdate_event does not exist

URL: /en-US/docs/Web/API/Document_Object_Model
Title: Document Object Model (DOM)
Flaw count: 43

  • macros:
    • /en-US/docs/Web/API/SVGFilterPrimitiveStandardAttributes does not exist
    • /en-US/docs/Web/API/SVGHatchElement does not exist
    • /en-US/docs/Web/API/SVGHatchpathElement does not exist
    • /en-US/docs/Web/API/SVGColor does not exist
    • /en-US/docs/Web/API/SVGICCColor does not exist
    • and 38 more flaws omitted

URL: /en-US/docs/Web/API/SVGElement
Title: SVGElement
Flaw count: 14

  • macros:
    • /en-US/docs/Web/API/DocumentAndElementEventHandlers does not exist
    • /en-US/docs/Web/API/SVGElementInstance does not exist
    • /en-US/docs/Web/API/SVGElement/attributeStyleMap does not exist
    • /en-US/docs/Web/API/SVGElement/className does not exist
    • /en-US/docs/Web/API/SVGElement/nonce does not exist
    • and 5 more flaws omitted
  • broken_links:
    • Can't resolve /en-US/docs/Web/API/SVGElement/abort_event
    • Can't resolve /en-US/docs/Web/API/SVGElement/resize_event
    • Can't resolve /en-US/docs/Web/API/SVGElement/scroll_event
    • Can't resolve /en-US/docs/Web/API/SVGElement/unload_event

URL: /en-US/docs/Web/API/HTMLMediaElement
Title: HTMLMediaElement
Flaw count: 12

  • macros:
    • /en-US/docs/Web/API/HTMLMediaElement/played does not exist
    • /en-US/docs/Web/API/HTMLMediaElement/preload does not exist
    • /en-US/docs/Web/API/HTMLMediaElement/seeking does not exist
    • /en-US/docs/Web/API/MediaController does not exist
    • /en-US/docs/Web/API/MediaController does not exist
    • and 7 more flaws omitted

URL: /en-US/docs/Web/API/MediaRecorder
Title: MediaRecorder
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/MediaRecorder/isTypeSupported redirects to /en-US/docs/Web/API/MediaRecorder/isTypeSupported_static

URL: /en-US/docs/Web/API/ImageCapture
Title: ImageCapture
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/PhotoSettings does not exist

URL: /en-US/docs/Web/API/KeyboardEvent
Title: KeyboardEvent
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/KeyboardEvent/locale does not exist
    • /en-US/docs/Web/API/KeyboardEvent/char does not exist
    • /en-US/docs/Web/API/KeyboardEvent/keyLocation does not exist

URL: /en-US/docs/Web/API/KeyboardEvent/charCode
Title: KeyboardEvent: charCode property
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Gecko_Keypress_Event

URL: /en-US/docs/Web/CSS/Mozilla_Extensions
Title: Mozilla CSS extensions
Flaw count: 36

  • macros:
    • /en-US/docs/Web/CSS/overflow-clip-box does not exist
    • /en-US/docs/Web/CSS/overflow-clip-box-block does not exist
    • /en-US/docs/Web/CSS/overflow-clip-box-inline does not exist
    • /en-US/docs/Web/CSS/::-moz-anonymous-block does not exist
    • /en-US/docs/Web/CSS/::-moz-anonymous-positioned-block does not exist
    • and 31 more flaws omitted
External URLs (5)

URL: /en-US/docs/Web/API/PresentationRequest
Title: PresentationRequest

URL: /en-US/docs/Web/API/Element
Title: Element

URL: /en-US/docs/Web/API/Document
Title: Document

URL: /en-US/docs/Web/API/Console_API
Title: Console API

URL: /en-US/docs/Web/CSS/@counter-style/additive-symbols
Title: additive-symbols

(comment last updated: 2023-08-03 12:37:17)

Josh-Cena
Josh-Cena previously requested changes Aug 2, 2023
View reviewed changes
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Could you make sure all the macros still display user-friendly text, apart from this one? Also, for the deprecated features, I'm not sure removing them is the right thing to do if they still exist; maybe we can just change it to plain text.

files/en-us/web/api/hidconnectionevent/index.md Outdated Show resolved Hide resolved
chrisdavidmills
chrisdavidmills approved these changes Aug 3, 2023
View reviewed changes
Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

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

@queengooborg A few more correction suggestions, but approving so as not to hold you up. Nice work!

files/en-us/web/api/html_dom_api/microtask_guide/in_depth/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/midiport/close/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/midiport/open/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/oscillatornode/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/oscillatornode/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/webusb_api/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/workletglobalscope/index.md Outdated Show resolved Hide resolved
files/en-us/web/css/@counter-style/additive-symbols/index.md Outdated Show resolved Hide resolved
files/en-us/web/css/css_houdini/index.md Outdated Show resolved Hide resolved
files/en-us/web/css/hue-interpolation-method/index.md Outdated Show resolved Hide resolved
queengooborg and others added 2 commits August 3, 2023 05:32
@queengooborg @Josh-Cena @chrisdavidmills
Apply suggestions from code review
ac3783e 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Chris Mills <chrisdavidmills@gmail.com>
@queengooborg
Apply suggestions from code review
5564ee5
@queengooborg queengooborg merged commit 56c7642 into main Aug 4, 2023
7 checks passed
@queengooborg queengooborg deleted the macros/xref-misc branch August 4, 2023 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisdavidmills chrisdavidmills chrisdavidmills approved these changes

@Josh-Cena Josh-Cena Josh-Cena left review comments

@Ryuno-Ki Ryuno-Ki Awaiting requested review from Ryuno-Ki

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

Assignees
No one assigned
Labels
Content:CSS Cascading Style Sheets docs Content:Other Any docs not covered by another "Content:" label Content:SVG SVG docs Content:WebAPI Web API docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@queengooborg @chrisdavidmills @Josh-Cena