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

Comment out ellipsis in code blocks #18534

Merged
merged 2 commits into from
Jul 20, 2022
Merged

Comment out ellipsis in code blocks #18534

merged 2 commits into from
Jul 20, 2022

Conversation

OnkarRuikar
Copy link
Contributor

Ellipsis in markdown code blocks are syntax errors.

In order to have smooth transition to Prettier and ESLint the PR comments out such bare ellipses. Refer the #18171 (comment) for more context.

@OnkarRuikar OnkarRuikar requested review from a team as code owners July 20, 2022 02:29
@OnkarRuikar OnkarRuikar requested review from Rumyra and removed request for a team July 20, 2022 02:29
@github-actions github-actions bot added Content:HTML Hypertext Markup Language docs Content:Learn Learning area docs Content:WebAPI Web API docs labels Jul 20, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 20, 2022 •
edited
Loading

Preview URLs

Flaws

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

URL: /en-US/docs/Web/API/WebRTC_API/Using_DTMF
Title: Using DTMF with WebRTC
on GitHub
Flaw count: 4

  • macros:
    • /en-US/docs/Web/API/MediaConstraints does not exist
    • /en-US/docs/Web/API/RTCPeerConnection/createDTMFSender does not exist
    • /en-US/docs/Web/API/RTCPeerConnection/getTracks does not exist
    • /en-US/docs/Web/API/RTCTrackEvent/stream does not exist

URL: /en-US/docs/Web/API/Window/openDialog
Title: Window.openDialog()
on GitHub
Flaw count: 4

  • macros:
    • /en-US/docs/Web/API/Window/arguments does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/Add-ons/Code_snippets/Dialogs_and_Prompts#passing_arguments_and_displaying_a_dialog
    • Can't resolve /en-US/docs/Mozilla/Add-ons/Code_snippets/Dialogs_and_Prompts#passing_arguments_and_displaying_a_dialog
    • Can't resolve /en-US/docs/Archive/Web/Window.importDialog

URL: /en-US/docs/Web/API/XRJointPose
Title: XRJointPose
on GitHub
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: api.XRJointPose

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

  • bad_bcd_queries:
    • No BCD data for query: api.XRJointPose.radius

URL: /en-US/docs/Web/API/WebXR_Device_API/Bounded_reference_spaces
Title: Using bounded reference spaces
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/XRReferenceSpace/requestOffsetReferenceSpace does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Web/API/WebXR_Device_API/Gamepads

URL: /en-US/docs/Web/API/XRJointSpace
Title: XRJointSpace
on GitHub
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: api.XRJointSpace

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

  • bad_bcd_queries:
    • No BCD data for query: api.XRJointSpace.jointName

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

  • bad_bcd_queries:
    • No BCD data for query: api.XRCylinderLayer.aspectRatio

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

  • bad_bcd_queries:
    • No BCD data for query: api.XRCylinderLayer.centralAngle

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

  • bad_bcd_queries:
    • No BCD data for query: api.XRCylinderLayer.radius

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

  • macros:
    • wrong xref macro used (consider changing which macro you use)
  • bad_bcd_queries:
    • No BCD data for query: api.XRInputSource.hand

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

  • bad_bcd_queries:
    • No BCD data for query: api.XRCompositionLayer.needsRedraw

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

  • bad_bcd_queries:
    • No BCD data for query: api.XRCompositionLayer.mipLevels

External URLs

URL: /en-US/docs/Web/API/WebRTC_API/Using_DTMF
Title: Using DTMF with WebRTC
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Window/unhandledrejection_event
Title: Window: unhandledrejection event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Window/setImmediate
Title: Window.setImmediate()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Window/openDialog
Title: Window.openDialog()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebSockets_API/Writing_a_WebSocket_server_in_Java
Title: Writing a WebSocket server in Java
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_server
Title: Writing a WebSocket server in C#
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebGLVertexArrayObject
Title: WebGLVertexArrayObject
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRJointPose
Title: XRJointPose
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRJointPose/radius
Title: XRJointPose.radius
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WorkerGlobalScope/importScripts
Title: WorkerGlobalScope.importScripts()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebXR_Device_API/Startup_and_shutdown
Title: Starting up and shutting down a WebXR session
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebXR_Device_API/Performance
Title: WebXR performance guide
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebXR_Device_API/Spatial_tracking
Title: Spaces and reference spaces: Spatial tracking in WebXR
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebXR_Device_API/Bounded_reference_spaces
Title: Using bounded reference spaces
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebXR_Device_API/Rendering
Title: Rendering and the WebXR frame animation callback
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRJointSpace
Title: XRJointSpace
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRJointSpace/jointName
Title: XRJointSpace.jointName
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRCylinderLayer/aspectRatio
Title: XRCylinderLayer.aspectRatio
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRCylinderLayer/centralAngle
Title: XRCylinderLayer.centralAngle
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRCylinderLayer/radius
Title: XRCylinderLayer.radius
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSource/hand
Title: XRInputSource.hand
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSource/targetRayMode
Title: XRInputSource.targetRayMode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSource/targetRaySpace
Title: XRInputSource.targetRaySpace
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRCompositionLayer/needsRedraw
Title: XRCompositionLayer.needsRedraw
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRCompositionLayer/mipLevels
Title: XRCompositionLayer.mipLevels
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebVR_API/Using_the_WebVR_API
Title: Using the WebVR API
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WEBGL_multi_draw
Title: WEBGL_multi_draw
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WEBGL_multi_draw/multiDrawElementsInstancedWEBGL
Title: WEBGL_multi_draw.multiDrawElementsInstancedWEBGL()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WEBGL_multi_draw/multiDrawArraysWEBGL
Title: WEBGL_multi_draw.multiDrawArraysWEBGL()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WEBGL_multi_draw/multiDrawElementsWEBGL
Title: WEBGL_multi_draw.multiDrawElementsWEBGL()
on GitHub

No new external URLs

(this comment was updated 2022-07-20 06:06:16.225784)

@OnkarRuikar OnkarRuikar changed the title Daily markdownlint Comment out ellipsis in code blocks Jul 20, 2022
@github-actions github-actions bot removed Content:Learn Learning area docs Content:HTML Hypertext Markup Language docs labels Jul 20, 2022
@OnkarRuikar @teoli2003
Apply suggestions from code review
5c2436c 
Co-authored-by: Jean-Yves Perrier <[email protected]>
teoli2003
teoli2003 approved these changes Jul 20, 2022
View reviewed changes
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.

😄

@teoli2003 teoli2003 merged commit 08495a2 into mdn:main Jul 20, 2022
@OnkarRuikar OnkarRuikar deleted the code-ellipsis4 branch July 20, 2022 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@teoli2003 teoli2003 teoli2003 approved these changes

@Rumyra Rumyra Awaiting requested review from Rumyra Rumyra is a code owner 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 @teoli2003