Skip to content

Comment out ellipsis in code blocks #18536

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
Merged
teoli2003 merged 3 commits into from
Jul 20, 2022
Merged

Comment out ellipsis in code blocks #18536

teoli2003 merged 3 commits into from
Jul 20, 2022

Conversation

@OnkarRuikar
Copy link
Contributor

@OnkarRuikar OnkarRuikar commented Jul 20, 2022

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:42
@OnkarRuikar OnkarRuikar requested review from estelle, schalkneethling and teoli2003 and removed request for a team July 20, 2022 02:42
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:Learn Learning area docs Content:Other Any docs not covered by another "Content:" label labels Jul 20, 2022
@github-actions
Copy link
Contributor

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

Preview URLs

Flaws

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

URL: /en-US/docs/Web/HTML/Global_attributes
Title: Global attributes
on GitHub
Flaw count: 1

  • bad_bcd_links:
    • no explanation!

URL: /en-US/docs/Web/HTML/Element/header
Title: <header>
on GitHub
Flaw count: 7

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/HTML/Element/h1 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h3 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h4 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • and 2 more flaws omitted

URL: /en-US/docs/Web/HTML/Element/Heading_Elements
Title: <h1>–<h6>: The HTML Section Heading elements
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/HTML/Element/main
Title: <main>
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements

URL: /en-US/docs/Web/HTML/Element/html
Title: <html>: The HTML Document / Root element
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/HTML/Element/aside
Title: <aside>: The Aside element
on GitHub
Flaw count: 7

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/HTML/Element/h1 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h3 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h4 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • and 2 more flaws omitted

URL: /en-US/docs/Web/HTML/Element/progress
Title: <progress>: The Progress Indicator element
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/HTML/Element/input/search
Title: <input type="search">
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/API/HTMLInputElement/value does not exist

URL: /en-US/docs/Web/HTML/Element/hgroup
Title: <hgroup>
on GitHub
Flaw count: 13

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/HTML/Element/h1 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h3 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h4 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • and 8 more flaws omitted

URL: /en-US/docs/Web/HTML/Element/sub
Title: <sub>: The Subscript element
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/HTML/Element/dialog
Title: <dialog>: The Dialog element
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/HTML/Element/track
Title: <track>: The Embed Text Track element
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/API/HTMLTrackElement/track does not exist

URL: /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
Title: Data URLs
on GitHub
Flaw count: 1

  • bad_bcd_links:
    • no explanation!

URL: /en-US/docs/Web/HTTP/CSP
Title: Content Security Policy (CSP)
on GitHub
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: http.headers.Content-Security-Policy

External URLs

URL: /en-US/docs/Web/Guide/Audio_and_video_delivery
Title: Audio and Video Delivery
on GitHub

No new external URLs

URL: /en-US/docs/Web/Guide/Audio_and_video_delivery/Video_player_styling_basics
Title: Video player styling basics
on GitHub

No new external URLs

URL: /en-US/docs/Web/Guide/Audio_and_video_delivery/Setting_up_adaptive_streaming_media_sources
Title: Setting up adaptive streaming media sources
on GitHub

No new external URLs

URL: /en-US/docs/Web/Guide/Audio_and_video_delivery/Cross-browser_audio_basics
Title: Cross-browser audio basics
on GitHub

No new external URLs

URL: /en-US/docs/Web/Guide/Audio_and_video_delivery/cross_browser_video_player
Title: Creating a cross-browser video player
on GitHub

No new external URLs

URL: /en-US/docs/Web/Guide/AJAX/Getting_Started
Title: Getting Started
on GitHub

No new external URLs

URL: /en-US/docs/Web/CSS/word-spacing
Title: word-spacing
on GitHub

No new external URLs

URL: /en-US/docs/Web/CSS/url
Title: url()
on GitHub

No new external URLs

URL: /en-US/docs/Web/Events/Creating_and_triggering_events
Title: Creating and triggering events
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Global_attributes
Title: Global attributes
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Global_attributes/is
Title: is
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Global_attributes/itemscope
Title: itemscope
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/header
Title: <header>
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/Heading_Elements
Title: <h1>–<h6>: The HTML Section Heading elements
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/main
Title: <main>
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/html
Title: <html>: The HTML Document / Root element
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/aside
Title: <aside>: The Aside element
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/progress
Title: <progress>: The Progress Indicator element
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/input/search
Title: <input type="search">
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/hgroup
Title: <hgroup>
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/sub
Title: <sub>: The Subscript element
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/dialog
Title: <dialog>: The Dialog element
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTML/Element/track
Title: <track>: The Embed Text Track element
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
Title: Data URLs
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTTP/Caching
Title: HTTP caching
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTTP/CSP
Title: Content Security Policy (CSP)
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTTP/Feature_Policy/Using_Feature_Policy
Title: Using Feature Policy
on GitHub

URL: /en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers
Title: Access-Control-Request-Headers
on GitHub

No new external URLs

URL: /en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
Title: Access-Control-Allow-Methods
on GitHub

No new external URLs

URL: /en-US/docs/Web/EXSLT
Title: EXSLT
on GitHub

No new external URLs

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

teoli2003
teoli2003 suggested changes Jul 20, 2022
View reviewed changes
OnkarRuikar and others added 2 commits July 20, 2022 11:31
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 5a9f418 into mdn:main Jul 20, 2022
@OnkarRuikar OnkarRuikar deleted the code-ellipsis6 branch July 20, 2022 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@teoli2003 teoli2003 teoli2003 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:Learn Learning area docs Content:Other Any docs not covered by another "Content:" label

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@OnkarRuikar @teoli2003