Skip to content

Comments

WebAPI: Clean syntax from property pages, part 20#14633

Merged
hamishwillee merged 2 commits intomdn:mainfrom
OnkarRuikar:onk-prop3
Apr 4, 2022
Merged

WebAPI: Clean syntax from property pages, part 20#14633
hamishwillee merged 2 commits intomdn:mainfrom
OnkarRuikar:onk-prop3

Conversation

@OnkarRuikar
Copy link
Contributor

@OnkarRuikar OnkarRuikar commented Apr 4, 2022

Sequel of #14195
As per the template API_property_subpage_template, Syntax section is redundant in property pages. So getting rid of the cruft.

Changes:

  • Removed syntax sections
  • Enforced heading names to ## Value, ## Examples.
  • Other small corrections

Metadata

  • Fixes a typo, bug, or other error

@OnkarRuikar OnkarRuikar requested a review from a team as a code owner April 4, 2022 02:40
@OnkarRuikar OnkarRuikar requested review from Rumyra and removed request for a team April 4, 2022 02:40
@github-actions github-actions bot added the Content:WebAPI Web API docs label Apr 4, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2022 •
edited
Loading

Preview URLs

Flaws

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

URL: /en-US/docs/Web/API/NodeIterator/referenceNode
Title: NodeIterator.referenceNode
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/NodeIterator/pointerBeforeReferenceNode
Title: NodeIterator.pointerBeforeReferenceNode
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/NodeIterator/filter
Title: NodeIterator.filter
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/NodeIterator/whatToShow
Title: NodeIterator.whatToShow
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/NodeIterator/expandEntityReferences
Title: NodeIterator.expandEntityReferences
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/NodeIterator/root
Title: NodeIterator.root
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/MediaRecorder/warning_event
Title: MediaRecorder.onwarning
on GitHub
Flaw count: 1

  • broken_links:
    • Is currently http:// but can become https://

URL: /en-US/docs/Web/API/PaymentResponse/shippingOption
Title: PaymentResponse.shippingOption
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/PaymentResponse/payerEmail
Title: PaymentResponse.payerEmail
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/PaymentResponse/payerPhone
Title: PayerResponse.payerPhone
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/Navigator/battery
Title: Navigator.battery
on GitHub
Flaw count: 3

  • broken_links:
    • Is currently http:// but can become https://
    • Is currently http:// but can become https://
  • bad_bcd_queries:
    • No BCD data for query: api.Navigator.battery

URL: /en-US/docs/Web/API/Navigator/maxTouchPoints
Title: Navigator.maxTouchPoints
on GitHub
Flaw count: 2

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

URL: /en-US/docs/Web/API/Navigator/languages
Title: Navigator.languages
on GitHub
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/Window/onlanguagechange redirects to /en-US/docs/Web/API/WindowEventHandlers/onlanguagechange

URL: /en-US/docs/Web/API/Navigator/productSub
Title: Navigator.productSub
on GitHub
Flaw count: 2

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

URL: /en-US/docs/Web/API/Navigator/cookieEnabled
Title: Navigator.cookieEnabled
on GitHub
Flaw count: 2

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

URL: /en-US/docs/Web/API/Navigator/doNotTrack
Title: Navigator.doNotTrack
on GitHub
Flaw count: 3

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
  • broken_links:
    • Can't resolve /en-US/docs/Web/Security/Do_not_track_field_guide

URL: /en-US/docs/Web/API/PaintWorklet/registerPaint
Title: PaintWorkletGlobalScope.registerPaint
on GitHub
Flaw count: 3

  • macros:
    • /en-US/docs/Web/CSS/paint() redirects to /en-US/docs/Web/CSS/image/paint
  • broken_links:
    • Can't resolve /en-US/docs/Web/Houdini
    • Can't resolve /en-US/docs/Web/Houdini/learn

URL: /en-US/docs/Web/API/LockedFile/oncomplete
Title: LockedFile.oncomplete
on GitHub
Flaw count: 3

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

URL: /en-US/docs/Web/API/LockedFile/onerror
Title: LockedFile.onerror
on GitHub
Flaw count: 3

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

URL: /en-US/docs/Web/API/LockedFile/onabort
Title: LockedFile.onabort
on GitHub
Flaw count: 3

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

URL: /en-US/docs/Web/API/KeyboardEvent/charCode
Title: KeyboardEvent.charCode
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/KeyboardEvent/which redirects to /en-US/docs/Web/API/UIEvent/which
  • broken_links:
    • Can't resolve /en-US/docs/Gecko_Keypress_Event

URL: /en-US/docs/Web/API/OffscreenCanvas/width
Title: OffscreenCanvas.width
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/OffscreenCanvas/height
Title: OffscreenCanvas.height
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/NodeList/length
Title: NodeList.length
on GitHub
Flaw count: 1

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

External URLs

URL: /en-US/docs/Web/API/NetworkInformation/downlinkMax
Title: NetworkInformation.downlinkMax
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NetworkInformation/rtt
Title: NetworkInformation.rtt
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NetworkInformation/type
Title: NetworkInformation.type
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/MediaKeySession/sessionId
Title: MediaKeySession.sessionId
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/MediaKeySession/expiration
Title: MediaKeySession.expiration
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/MediaKeySession/keyStatuses
Title: MediaKeySession.keyStatuses
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NodeIterator/referenceNode
Title: NodeIterator.referenceNode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NodeIterator/pointerBeforeReferenceNode
Title: NodeIterator.pointerBeforeReferenceNode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NodeIterator/filter
Title: NodeIterator.filter
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NodeIterator/whatToShow
Title: NodeIterator.whatToShow
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NodeIterator/expandEntityReferences
Title: NodeIterator.expandEntityReferences
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NodeIterator/root
Title: NodeIterator.root
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/MediaRecorder/warning_event
Title: MediaRecorder.onwarning
on GitHub

URL: /en-US/docs/Web/API/MouseEvent/screenX
Title: MouseEvent.screenX
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PaymentResponse/shippingOption
Title: PaymentResponse.shippingOption
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PaymentResponse/payerEmail
Title: PaymentResponse.payerEmail
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PaymentResponse/details
Title: PaymentResponse.details
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PaymentResponse/payerPhone
Title: PayerResponse.payerPhone
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/MediaKeyMessageEvent/messageType
Title: MediaKeyMessageEvent.messageType
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/MediaKeyMessageEvent/message
Title: MediaKeyMessageEvent.message
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NotificationEvent/notification
Title: NotificationEvent.notification
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NotificationEvent/action
Title: NotificationEvent.action
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/battery
Title: Navigator.battery
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/maxTouchPoints
Title: Navigator.maxTouchPoints
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/languages
Title: Navigator.languages
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/productSub
Title: Navigator.productSub
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/geolocation
Title: Navigator.geolocation
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/cookieEnabled
Title: Navigator.cookieEnabled
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/doNotTrack
Title: Navigator.doNotTrack
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/MediaKeySystemAccess/keySystem
Title: MediaKeySystemAccess.keySystem
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PaintWorklet/registerPaint
Title: PaintWorkletGlobalScope.registerPaint
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/LockedFile/oncomplete
Title: LockedFile.oncomplete
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/LockedFile/onerror
Title: LockedFile.onerror
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/LockedFile/onabort
Title: LockedFile.onabort
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/altKey
Title: KeyboardEvent.altKey
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/code
Title: KeyboardEvent.code
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/isComposing
Title: KeyboardEvent.isComposing
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/repeat
Title: KeyboardEvent.repeat
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/charCode
Title: KeyboardEvent.charCode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/shiftKey
Title: KeyboardEvent.shiftKey
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/key
Title: KeyboardEvent.key
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/ctrlKey
Title: KeyboardEvent.ctrlKey
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/metaKey
Title: KeyboardEvent.metaKey
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/location
Title: KeyboardEvent.location
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PaymentRequest/shippingOption
Title: PaymentRequest.shippingOption
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PaymentRequest/shippingAddress
Title: PaymentRequest.shippingAddress
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/OffscreenCanvas/width
Title: OffscreenCanvas.width
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/OffscreenCanvas/height
Title: OffscreenCanvas.height
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PaymentAddress/toJSON
Title: PaymentAddress.toJSON()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/NodeList/length
Title: NodeList.length
on GitHub

No new external URLs

(this comment was updated 2022-04-04 03:37:20.357478)

hamishwillee
hamishwillee approved these changes Apr 4, 2022
View reviewed changes
Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

LGTM!

@hamishwillee hamishwillee merged commit 4afce6d into mdn:main Apr 4, 2022
@OnkarRuikar OnkarRuikar deleted the onk-prop3 branch April 4, 2022 03:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hamishwillee hamishwillee hamishwillee approved these changes

@Rumyra Rumyra Awaiting requested review from Rumyra Rumyra was automatically assigned from mdn/yari-content-web-api

Assignees

No one assigned

Labels

Content:WebAPI Web API docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@OnkarRuikar @hamishwillee