Skip to content

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 discussion for more context.

@OnkarRuikar OnkarRuikar requested review from a team as code owners July 17, 2022 01:44
@OnkarRuikar OnkarRuikar requested review from wbamberg and removed request for a team July 17, 2022 01:44
@github-actions github-actions bot added Content:JS JavaScript docs Content:WebAPI Web API docs labels Jul 17, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 17, 2022

Preview URLs

Flaws

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

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGeneratorFunction
Title: AsyncGeneratorFunction
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/Guide/Iterators_and_generators

URL: /en-US/docs/Web/API/EventTarget/addEventListener
Title: EventTarget.addEventListener()
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/EventListener redirects to /en-US/docs/Web/API/EventTarget/addEventListener

URL: /en-US/docs/Web/API/Element/cut_event
Title: Element: cut event
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/HTMLElement/oncut redirects to /en-US/docs/Web/API/HTMLElement/cut_event

URL: /en-US/docs/Web/API/Element/paste_event
Title: Element: paste event
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/HTMLElement/onpaste redirects to /en-US/docs/Web/API/HTMLElement/paste_event

URL: /en-US/docs/Web/API/Element/copy_event
Title: Element: copy event
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/HTMLElement/oncopy redirects to /en-US/docs/Web/API/HTMLElement/copy_event

URL: /en-US/docs/Web/API/TreeWalker
Title: TreeWalker
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/NodeFilter redirects to /en-US/docs/Web/API/Document/createNodeIterator
    • /en-US/docs/Web/API/NodeFilter redirects to /en-US/docs/Web/API/Document/createNodeIterator

External URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGeneratorFunction
Title: AsyncGeneratorFunction
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/File_API/Using_files_from_web_applications
Title: Using files from web applications
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/EventTarget/addEventListener
Title: EventTarget.addEventListener()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/after
Title: Element.after()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/cut_event
Title: Element: cut event
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/paste_event
Title: Element: paste event
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/ariaRoleDescription
Title: Element.ariaRoleDescription
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/prepend
Title: Element.prepend()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/innerHTML
Title: Element.innerHTML
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/before
Title: Element.before()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/append
Title: Element.append()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/replaceWith
Title: Element.replaceWith()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/ariaPosInSet
Title: Element.ariaPosInSet
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/tagName
Title: Element.tagName
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/replaceChildren
Title: Element.replaceChildren()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/hasPointerCapture
Title: Element.hasPointerCapture()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Element/copy_event
Title: Element: copy event
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/FileReader/abort_event
Title: FileReader: abort event
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/FileReader/load_event
Title: FileReader: load event
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Event/bubbles
Title: Event.bubbles
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Event/defaultPrevented
Title: Event.defaultPrevented
on GitHub

No new external URLs


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

No new external URLs


URL: /en-US/docs/Web/API/ElementInternals/validity
Title: ElementInternals.validity
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/ElementInternals/willValidate
Title: ElementInternals.willValidate
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/EXT_disjoint_timer_query/deleteQueryEXT
Title: EXT_disjoint_timer_query.deleteQueryEXT()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/EXT_disjoint_timer_query/isQueryEXT
Title: EXT_disjoint_timer_query.isQueryEXT()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/EXT_disjoint_timer_query/getQueryObjectEXT
Title: EXT_disjoint_timer_query.getQueryObjectEXT()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/EXT_disjoint_timer_query/queryCounterEXT
Title: EXT_disjoint_timer_query.queryCounterEXT()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/EXT_disjoint_timer_query/beginQueryEXT
Title: EXT_disjoint_timer_query.beginQueryEXT()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/EXT_disjoint_timer_query/endQueryEXT
Title: EXT_disjoint_timer_query.endQueryEXT()
on GitHub

No new external URLs


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

No new external URLs


URL: /en-US/docs/Web/API/FetchEvent/request
Title: FetchEvent.request
on GitHub

No new external URLs

(this comment was updated 2022-07-17 05:18:33.978816)

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.

A few nits and we can merge this.

@OnkarRuikar
Copy link
Contributor Author

Some pages on mdn/content have placeholder sections like:

…

## Description

## Examples

```js
```

Should we remove them?

@teoli2003
Copy link
Contributor

teoli2003 commented Jul 17, 2022

Should we remove them?

Yes, please. That way, when we start enforcing the presence of the mandatory sections, they will be listed as missing the examples. Also, it gives false expectations to the reader that believes there is an example and is disappointed when it reaches the section.

This is a remnant of the Wiki era where authors edited the new pages directly in the live MDN, then forget about it (because some manager told them to move to something more urgent)

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 caf21bf into mdn:main Jul 17, 2022
@OnkarRuikar OnkarRuikar deleted the code-ellipsis10 branch July 17, 2022 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:JS JavaScript docs Content:WebAPI Web API docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants