[Markdown] [Web/API] Fix notes and warnings that omit spaces #8545

wbamberg · 2021-09-01T23:39:45Z

Part of #7898 .

m2h expects a space after **Note:** or **Warning:**, like this:

> **Note**: A note!

...and will treat the structure as a normal blockquote if the space is missing. However, h2m does not flag this as an unconvertible note. So HTML like this:

<div class="note">
<p>strong>Note:</strong>A note.</p>
</div>

....will be converted "successfully" but then rendered as a blockquote.

Because cases like this weren't flagged as unconvertible I never noticed them when fixing up note and warning syntax.

This PR remedies that. Note that this PR also replaces   with a normal space - I think m2h does treat that as a normal space, but it was easier just to fix all of them to be the same.

github-actions · 2021-09-01T23:41:24Z

Preview URLs

Flaws

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

URL: /en-US/docs/Web/API/KeyboardEvent/charCode
Title: KeyboardEvent.charCode
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/Gecko_Keypress_Event

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

macros:
- /en-US/docs/Web/API/Data_Store_API does not exist
- /en-US/docs/Web/API/DOMRequest does not exist
- /en-US/docs/Web/API/DOMCursor does not exist

URL: /en-US/docs/Web/API/CSS_Font_Loading_API
Title: CSS Font Loading API
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/API/FontFaceSource does not exist
- /en-US/docs/Web/API/FontFaceSources/fonts does not exist

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

bad_bcd_queries:
- No BCD data for query: api.AudioWorkletProcessor.process

URL: /en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB
Title: Using IndexedDB
on GitHub
Flaw count: 3

broken_links:
- Is currently http:// but can become https://
- Is currently http:// but can become https://
- Is currently http:// but can become https://

URL: /en-US/docs/Web/API/Permissions_API
Title: Permissions API
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/Navigator/registerProtocolHandler/Web-based_protocol_handlers
Title: Web-based protocol handlers
on GitHub
Flaw count: 2

broken_links:
- Can't resolve /en-US/docs/XPCOM_Interface_Reference/nsIProtocolHandler
- Is currently http:// but can become https://

URL: /en-US/docs/Web/API/WebRTC_API/Signaling_and_video_calling
Title: Signaling and video calling
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/API/RTCPeerConnection/onremovetrack does not exist
- /en-US/docs/Web/API/HTMLElement/disabled does not exist

URL: /en-US/docs/Web/API/TextRange
Title: TextRange
on GitHub
Flaw count: 29

macros:
- /en-US/docs/Web/API/Element/createTextRange does not exist
- /en-US/docs/Web/API/Document/selection/createRange does not exist
- /en-US/docs/Web/API/TextRange/boundingHeight does not exist
- /en-US/docs/Web/API/TextRange/boundingLeft does not exist
- /en-US/docs/Web/API/TextRange/boundingTop does not exist
- and 24 more flaws omitted

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

macros:
- /en-US/docs/Web/API/TouchEvent/rotation does not exist
- /en-US/docs/Web/API/TouchEvent/scale does not exist

URL: /en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API
Title: Using the Web Animations API
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/API/ComputedEffectTiming does not exist
- /en-US/docs/Web/API/ComputedEffectTiming/duration does not exist

URL: /en-US/docs/Web/API/Web_Audio_API/Advanced_techniques
Title: Advanced techniques: Creating and sequencing audio
on GitHub
Flaw count: 1

broken_links:
- Is currently http:// but can become https://

URL: /en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet
Title: Background audio processing using AudioWorklet
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/API/AudioContext/destination redirects to /en-US/docs/Web/API/BaseAudioContext/destination
- /en-US/docs/Web/API/AudioParamMap/get does not exist

URL: /en-US/docs/Web/API/LocalFileSystemSync/requestFileSystemSync
Title: LocalFileSystemSync.requestFileSystemSync()
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/API/LocalFileSystem/requestFileSystem does not exist
bad_bcd_queries:
- No BCD data for query: api.LocalFileSystemSync.requestFileSystemSync

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

broken_links:
- Can't resolve /en-US/docs/Web/HTML/Using_the_application_cache

URL: /en-US/docs/Web/API/WebVR_API/Concepts
Title: WebVR concepts
on GitHub
Flaw count: 3

broken_links:
- Is currently http:// but can become https://
- Is currently http:// but can become https://
- Is currently http:// but can become https://

URL: /en-US/docs/Web/API/SharedWorkerGlobalScope/applicationCache
Title: SharedWorkerGlobalScope.applicationCache
on GitHub
Flaw count: 3

macros:
- /en-US/docs/Web/API/ApplicationCache does not exist
- /en-US/docs/Web/API/ApplicationCache does not exist
broken_links:
- Can't resolve /en-US/docs/Web/HTML/Using_the_application_cache

URL: /en-US/docs/Web/API/HTML_Drag_and_Drop_API/Recommended_drag_types
Title: Recommended Drag Types
on GitHub
Flaw count: 2

broken_links:
- Can't resolve /en-US/docs/XPCOM_Interface_Reference/nsIFile
- Can't resolve /en-US/docs/XPCOM_Interface_Reference/nsIInputStream

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/Element/scrollLeft
Title: Element.scrollLeft
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/CookieStore/delete
Title: CookieStore.delete()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/CookieStore/get
Title: CookieStore.get()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/CookieStore/getAll
Title: CookieStore.getAll()
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/KeyboardEvent/charCode
Title: KeyboardEvent.charCode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/AnalyserNode/smoothingTimeConstant
Title: AnalyserNode.smoothingTimeConstant
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/MouseEvent/initMouseEvent
Title: MouseEvent.initMouseEvent()
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/CSS_Font_Loading_API
Title: CSS Font Loading API
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/File/getAsText
Title: File.getAsText()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/File/getAsBinary
Title: File.getAsBinary()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/AudioWorkletProcessor/process
Title: AudioWorkletProcessor.process
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB
Title: Using IndexedDB
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/DOMParser
Title: DOMParser
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/Document/keypress_event
Title: Document: keypress event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/registerProtocolHandler/Web-based_protocol_handlers
Title: Web-based protocol handlers
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/console/profileEnd
Title: console.profileEnd()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WebRTC_API/Signaling_and_video_calling
Title: Signaling and video calling
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/Remote_Playback_API
Title: Remote Playback API
on GitHub

https://developer.apple.com/library/archive/releasenotes/General/WhatsNewInSafari/Articles/Safari_9_0.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
Title: Using server-sent events
on GitHub

https://bugs.chromium.org/p/chromium/issues/detail?id=275955 (1 time) (Note! This may be a new URL 👀)
https://bugzilla.mozilla.org/show_bug.cgi?id=906896 (1 time) (Note! This may be a new URL 👀)
https://stackoverflow.com/a/5326159/1905229 (1 time) (Note! This may be a new URL 👀)

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

No new external URLs

URL: /en-US/docs/Web/API/Media_Capabilities_API/Using_the_Media_Capabilities_API
Title: Using the Media Capabilities API
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/PublicKeyCredentialRequestOptions/allowCredentials
Title: PublicKeyCredentialRequestOptions.allowCredentials
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Screen/lockOrientation
Title: Screen.lockOrientation()
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API
Title: Using the Web Animations API
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/Web_Audio_API/Advanced_techniques
Title: Advanced techniques: Creating and sequencing audio
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet
Title: Background audio processing using AudioWorklet
on GitHub

https://bugs.chromium.org/p/chromium/issues/detail?id=921354 (1 time) (Note! This may be a new URL 👀)

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

https://en.wikipedia.org/wiki/Digital_audio (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/Hertz (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/Sampling_frequency (1 time) (Note! This may be a new URL 👀)

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

No new external URLs

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

https://bugs.chromium.org/p/chromium/issues/detail?id=275955 (1 time) (Note! This may be a new URL 👀)
https://bugzilla.mozilla.org/show_bug.cgi?id=906896 (1 time) (Note! This may be a new URL 👀)
https://stackoverflow.com/a/5326159/1905229 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/LocalFileSystemSync/requestFileSystemSync
Title: LocalFileSystemSync.requestFileSystemSync()
on GitHub

https://www.w3.org/TR/file-system-api/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/Window/applicationCache
Title: Window.applicationCache
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Window/defaultStatus
Title: Window.defaultStatus
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/GlobalEventHandlers/onkeypress
Title: GlobalEventHandlers.onkeypress
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/WebVR_API/Concepts
Title: WebVR concepts
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/HTMLImageElement/name
Title: HTMLImageElement.name
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/HTMLImageElement/vspace
Title: HTMLImageElement.vspace
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/HTMLImageElement/isMap
Title: HTMLImageElement.isMap
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/HTMLImageElement/hspace
Title: HTMLImageElement.hspace
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/PushSubscription/subscriptionId
Title: PushSubscription.subscriptionId
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/SharedWorkerGlobalScope/applicationCache
Title: SharedWorkerGlobalScope.applicationCache
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/HTML_Drag_and_Drop_API/Recommended_drag_types
Title: Recommended Drag Types
on GitHub

No new external URLs

wbamberg added 2 commits September 1, 2021 16:19

Ensure Note: is followed by a space

702ed44

Ensure Warning: is followed by a space

65df263

wbamberg requested a review from a team as a code owner September 1, 2021 23:39

wbamberg requested review from sideshowbarker and removed request for a team September 1, 2021 23:39

sideshowbarker approved these changes Sep 1, 2021

View reviewed changes

sideshowbarker merged commit 19032ca into mdn:main Sep 1, 2021

github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Markdown] [Web/API] Fix notes and warnings that omit spaces #8545

[Markdown] [Web/API] Fix notes and warnings that omit spaces #8545

wbamberg commented Sep 1, 2021

github-actions bot commented Sep 1, 2021

[Markdown] [Web/API] Fix notes and warnings that omit spaces #8545

[Markdown] [Web/API] Fix notes and warnings that omit spaces #8545

Conversation

wbamberg commented Sep 1, 2021

github-actions bot commented Sep 1, 2021

Preview URLs

Flaws

External URLs