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 #18435

Merged
merged 3 commits into from
Jul 17, 2022
Merged

Comment out ellipsis in code blocks #18435

merged 3 commits into from
Jul 17, 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 a review from a team as a code owner July 17, 2022 02:30
@OnkarRuikar OnkarRuikar requested review from Rumyra and removed request for a team July 17, 2022 02:30
@github-actions github-actions bot added the Content:WebAPI Web API docs label Jul 17, 2022
@github-actions
Copy link
Contributor

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

Preview URLs

Flaws

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

URL: /en-US/docs/Web/API/Pointer_events
Title: Pointer events
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/Element/gotpointercapture_event redirects to /en-US/docs/Web/API/HTMLElement/gotpointercapture_event
    • /en-US/docs/Web/API/Element/lostpointercapture_event redirects to /en-US/docs/Web/API/HTMLElement/lostpointercapture_event

URL: /en-US/docs/Web/API/RTCDtlsTransport/error_event
Title: RTCDtlsTransport: error event
on GitHub
Flaw count: 2

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

External URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/fetchStart
Title: PerformanceResourceTiming.fetchStart
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/connectStart
Title: PerformanceResourceTiming.connectStart
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/workerStart
Title: PerformanceResourceTiming.workerStart
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/redirectStart
Title: PerformanceResourceTiming.redirectStart
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/requestStart
Title: PerformanceResourceTiming.requestStart
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/domainLookupEnd
Title: PerformanceResourceTiming.domainLookupEnd
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/domainLookupStart
Title: PerformanceResourceTiming.domainLookupStart
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/secureConnectionStart
Title: PerformanceResourceTiming.secureConnectionStart
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/connectEnd
Title: PerformanceResourceTiming.connectEnd
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/redirectEnd
Title: PerformanceResourceTiming.redirectEnd
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/responseStart
Title: PerformanceResourceTiming.responseStart
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/responseEnd
Title: PerformanceResourceTiming.responseEnd
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceResourceTiming/initiatorType
Title: PerformanceResourceTiming.initiatorType
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Performance/getEntries
Title: performance.getEntries()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Performance/now
Title: performance.now()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Performance/getEntriesByName
Title: performance.getEntriesByName()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Performance/getEntriesByType
Title: performance.getEntriesByType()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Performance/setResourceTimingBufferSize
Title: performance.setResourceTimingBufferSize()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/ProcessingInstruction/sheet
Title: ProcessingInstruction.sheet
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Performance_Timeline/Using_Performance_Timeline
Title: Using Performance Timeline
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCDataChannel/error_event
Title: RTCDataChannel: error event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCDataChannel/label
Title: RTCDataChannel.label
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCDataChannel/bufferedAmount
Title: RTCDataChannel.bufferedAmount
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCDataChannel/close
Title: RTCDataChannel.close()
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/ReportingObserver/takeRecords
Title: ReportingObserver.takeRecords()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Pointer_events
Title: Pointer events
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API
Title: Using the Resource Timing API
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PerformanceObserver/disconnect
Title: PerformanceObserver.disconnect()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/RTCDtlsTransport/error_event
Title: RTCDtlsTransport: error event
on GitHub

No new external URLs

(this comment was updated 2022-07-17 06:05:56.739949)

teoli2003
teoli2003 suggested changes Jul 17, 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.

Found a few errors left fro var -> const. Also let's get rid of the undefined log() function, in favour of console.log(). (log() is a good idea in production code, but makes the snippet impossible to cut&paste)

files/en-us/web/api/performance/getentries/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance/getentriesbyname/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance/getentriesbyname/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance/getentriesbytype/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance/getentriesbytype/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceresourcetiming/requeststart/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceresourcetiming/responseend/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceresourcetiming/responsestart/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceresourcetiming/secureconnectionstart/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performanceresourcetiming/workerstart/index.md Outdated Show resolved Hide resolved
@OnkarRuikar
Copy link
Contributor Author

Thanks!
I am trying not to touch code as it may break some samples and lead to more PRs.

Found a few errors left fro var -> const.

Yes I used to find some in those PRs(after merge). But I've stopped doing that…

teoli2003
teoli2003 approved these changes Jul 17, 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 db53985 into mdn:main Jul 17, 2022
@OnkarRuikar OnkarRuikar deleted the code-ellipsis14 branch July 17, 2022 06:19
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