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

[Markdown] [Web/API] Fix some unconvertible tables #8588

Merged
merged 3 commits into from
Sep 4, 2021
Merged

[Markdown] [Web/API] Fix some unconvertible tables #8588

merged 3 commits into from
Sep 4, 2021

Conversation

wbamberg
Copy link
Collaborator

@wbamberg wbamberg commented Sep 3, 2021

Part of #7898 .

This PR fixes some tables that didn't convert into Markdown. There are a few different strategies here:

  • the most common is to give tables a proper heading, which GFM expects
  • in some cases a different element, like a <pre> or a <dl> seemed more appropriate
  • in some cases, where it didn't seem to hurt the content, I removed some <p> tags inside cells, as GFM doesn't support block elements in cells
  • in a few cases I deleted obsolete notes

@wbamberg wbamberg requested a review from a team as a code owner September 3, 2021 06:41
@wbamberg wbamberg requested review from jpmedley and removed request for a team September 3, 2021 06:42
@github-actions
Copy link
Contributor

github-actions bot commented Sep 3, 2021 •
edited
Loading

Preview URLs

Flaws

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

URL: /en-US/docs/Web/API/BackgroundFetchManager/fetch
Title: BackgroundFetchManager.fetch()
on GitHub
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/RequestInfo does not exist
    • /en-US/docs/Web/API/BackgroundFetchOptions does not exist
    • /en-US/docs/Web/API/ServiceWorkerRegistration/backgroundFetch does not exist

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

  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/IME_handling_guide

URL: /en-US/docs/Web/API/MutationRecord
Title: MutationRecord
on GitHub
Flaw count: 20

  • macros:
    • /en-US/docs/Web/API/MutationRecord/type does not exist
    • /en-US/docs/Web/API/MutationRecord/target does not exist
    • /en-US/docs/Web/API/MutationRecord/type does not exist
    • /en-US/docs/Web/API/MutationRecord/addedNodes does not exist
    • /en-US/docs/Web/API/MutationRecord/removedNodes does not exist
    • and 6 more flaws omitted
  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!
    • and 4 more flaws omitted

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

  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/IME_handling_guide

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

  • broken_links:
    • Can't resolve /en-US/docs/Code_snippets/XPath

URL: /en-US/docs/Web/API/FileReader
Title: FileReader
on GitHub
Flaw count: 8

  • macros:
    • /en-US/docs/Web/API/FileReader/onloadstart does not exist
    • /en-US/docs/Web/API/FileReader/onloadend does not exist
    • /en-US/docs/Web/API/FileReader/onprogress does not exist
    • /en-US/docs/Web/API/FileReader/onloadend does not exist
    • /en-US/docs/Web/API/FileReader/onloadstart does not exist
    • and 1 more flaws omitted
  • bad_bcd_links:
    • no explanation!
    • no explanation!

URL: /en-US/docs/Web/API/HTMLOptionsCollection
Title: HTMLOptionsCollection
on GitHub
Flaw count: 4

  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!

URL: /en-US/docs/Web/API/XMLHttpRequest/upload
Title: XMLHttpRequest.upload
on GitHub
Flaw count: 8

  • macros:
    • /en-US/docs/Web/API/XMLHttpRequestUpload does not exist
    • /en-US/docs/Web/API/XMLHttpRequest/onloadstart does not exist
    • /en-US/docs/Web/API/XMLHttpRequest/onprogress does not exist
    • /en-US/docs/Web/API/XMLHttpRequest/onabort does not exist
    • /en-US/docs/Web/API/XMLHttpRequest/onerror does not exist
    • and 3 more flaws omitted

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

  • macros:
    • /en-us/docs/web/api/keyevent (url: /en-US/docs/Web/API/KeyEvent) does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/Boot_to_Gecko

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

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

URL: /en-US/docs/Web/API/HTMLTrackElement
Title: HTMLTrackElement
on GitHub
Flaw count: 12

  • macros:
    • /en-US/docs/Web/API/HTMLTrackElement/kind does not exist
    • /en-US/docs/Web/API/HTMLTrackElement/srclang does not exist
    • /en-US/docs/Web/API/HTMLTrackElement/label does not exist
    • /en-US/docs/Web/API/HTMLTrackElement/default does not exist
    • /en-US/docs/Web/API/HTMLTrackElement/readyState does not exist
    • and 1 more flaws omitted
  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!
    • and 1 more flaws omitted

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

  • broken_links:
    • Can't resolve /en-US/docs/Mozilla/IME_handling_guide

URL: /en-US/docs/Web/API/CSSPrimitiveValue
Title: CSSPrimitiveValue
on GitHub
Flaw count: 4

  • macros:
    • /en-US/docs/Web/API/RGBColor does not exist
    • /en-US/docs/Web/API/Counter does not exist
    • /en-US/docs/Web/API/RGBColor does not exist
    • /en-US/docs/Web/API/Rect does not exist

URL: /en-US/docs/Web/API/MouseWheelEvent
Title: MouseWheelEvent
on GitHub
Flaw count: 3

  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!

URL: /en-US/docs/Web/API/WheelEvent
Title: WheelEvent
on GitHub
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/WheelEvent/wheelDelta does not exist
    • /en-US/docs/Web/API/WheelEvent/wheelDeltaX does not exist
    • /en-US/docs/Web/API/WheelEvent/wheelDeltaY does not exist

URL: /en-US/docs/Web/API/AudioProcessingEvent
Title: AudioProcessingEvent
on GitHub
Flaw count: 4

  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!

External URLs

URL: /en-US/docs/Web/API/BackgroundFetchManager/fetch
Title: BackgroundFetchManager.fetch()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API
Title: Basic concepts behind Web Audio API
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/SVGRect/The__X__property
Title: The 'X' property
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/HTML_DOM_API/Microtask_guide
Title: Using microtasks in JavaScript with queueMicrotask()
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/CSSValue/cssValueType
Title: CSSValue.cssValueType
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WindowEventHandlers/onhashchange
Title: WindowEventHandlers.onhashchange
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Document/evaluate
Title: Document.evaluate()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Document/createNodeIterator
Title: Document.createNodeIterator()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Document/createTreeWalker
Title: Document.createTreeWalker()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Cache/add
Title: Cache.add()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Cache/addAll
Title: Cache.addAll()
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/WebGL_API/Types
Title: WebGL types
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/CanvasRenderingContext2D/drawWindow
Title: CanvasRenderingContext2D.drawWindow()
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/XPathResult/resultType
Title: XPathResult.resultType
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/XMLHttpRequest/upload
Title: XMLHttpRequest.upload
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XMLHttpRequest/readyState
Title: XMLHttpRequest.readyState
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/KeyboardEvent/location
Title: KeyboardEvent.location
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/NodeFilter/acceptNode
Title: NodeFilter.acceptNode()
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/CSSPrimitiveValue/primitiveType
Title: CSSPrimitiveValue.primitiveType
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/CSSPrimitiveValue/setFloatValue
Title: CSSPrimitiveValue.setFloatValue()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/CSSPrimitiveValue/getFloatValue
Title: CSSPrimitiveValue.getFloatValue()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/CSSPrimitiveValue/setStringValue
Title: CSSPrimitiveValue.setStringValue()
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/WebGLRenderingContext/blendFunc
Title: WebGLRenderingContext.blendFunc()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebGLRenderingContext/blendFuncSeparate
Title: WebGLRenderingContext.blendFuncSeparate()
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/Encoding_API/Encodings
Title: Encoding API Encodings
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/WheelEvent/deltaMode
Title: WheelEvent.deltaMode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WheelEvent/WheelEvent
Title: WheelEvent()
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/WebSocket/readyState
Title: WebSocket.readyState
on GitHub

No new external URLs

(this comment was updated 2021-09-04 03:46:32.955723)

teoli2003
teoli2003 suggested changes Sep 3, 2021
View reviewed changes
files/en-us/web/api/nodefilter/acceptnode/index.html Outdated
<tr>
<td class="header">Constant</td>
<td class="header">Description</td>
<th scope="col">Constant</th>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why the scope="col" on this one?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No good reason, just copy/paste.

files/en-us/web/api/nodefilter/index.html Outdated
@@ -33,8 +33,8 @@ <h2 id="Methods">Methods</h2>
<table class="standard-table">
<thead>
<tr>
<th class="header" scope="col">Constant</th>
<th class="header" scope="col">Description</th>
<th scope="col">Constant</th>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why the scope="col" on this one?

files/en-us/web/api/mousescrollevent/index.html
</tr>
</tbody>
</table>
<pre>void initMouseScrollEvent(
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should remove the idl from this file, but no reason to do it in this PR. One day…

files/en-us/web/api/webgl_api/types/index.html Show resolved Hide resolved
files/en-us/web/api/web_audio_api/basic_concepts_behind_web_audio_api/index.html Show resolved Hide resolved
@teoli2003
Copy link
Contributor

You are entering into the complex cases world. I've noticed a few follow-ups to do (the old way of doing stuff), but no need to block this PR on these.

@wbamberg wbamberg mentioned this pull request Sep 3, 2021
Closed
13 tasks
@wbamberg
Copy link
Collaborator Author

wbamberg commented Sep 3, 2021

Thanks @teoli2003 ! I will take a look at your comments later.

There's some more context on this at #7898 (comment).

@teoli2003
Copy link
Contributor

Sure, renominate me for review once you have made the changes (especially if you do several commits)

@teoli2003 teoli2003 merged commit 1aed517 into mdn:main Sep 4, 2021
@teoli2003
Copy link
Contributor

Nice!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@teoli2003 teoli2003 teoli2003 approved these changes

@jpmedley jpmedley Awaiting requested review from jpmedley

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@wbamberg @teoli2003