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

Fix bad note names #8219

Merged
merged 3 commits into from
Aug 23, 2021
Merged

Fix bad note names #8219

merged 3 commits into from
Aug 23, 2021

Conversation

wbamberg
Copy link
Collaborator

This is part of #8180.

The focus of this one is notes which did have a structure like <p><strong>Thing</strong></p>, but Thing wasn't "Note:".

There are actually three commits here: the first manually fixes up some notes just so the scripts could work better, the second auto-fixes <p><strong>Availability:</strong></p> and the third fixes a few different choices, like <p><strong>Tip</strong></p> and <p><strong>Notes</strong></p> etc.

In a few places I thought the text flowed better without them being notes, and in a few I felt warnings were more appropriate.

@wbamberg wbamberg requested a review from a team as a code owner August 23, 2021 05:02
@wbamberg wbamberg requested review from sideshowbarker and removed request for a team August 23, 2021 05:02
@github-actions
Copy link
Contributor

Preview URLs

Flaws

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

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/KeyboardEvent/initKeyEvent
Title: KeyboardEvent.initKeyEvent()
on GitHub
Flaw count: 2

  • macros:
    • /en-us/docs/web/api/keyevent (url: /en-US/docs/Web/API/KeyEvent) does not exist
    • /en-US/docs/Web/API/Keyboard/initKeyboardEvent does not exist

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/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/CloseEvent/initCloseEvent
Title: CloseEvent.initCloseEvent()
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/CloseEvent/MouseEvent does not exist

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

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

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/CSSStyleSheet
Title: CSSStyleSheet
on GitHub
Flaw count: 4

  • macros:
    • /en-US/docs/Web/API/HTMLLinkElement/sheet does not exist
    • /en-US/docs/Web/API/HTMLStyleElement/sheet does not exist
    • /en-US/docs/Web/API/SVGStyleElement/sheet does not exist
    • /en-US/docs/Web/API/ProcessingInstruction/sheet does not exist

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

  • macros:
    • /en-US/docs/Web/API/JavaScriptNode does not exist
  • broken_links:
    • Is currently http:// but can become https://
    • Is currently http:// but can become https://

URL: /en-US/docs/Web/API/Navigation_timing_API
Title: Navigation Timing API
on GitHub
Flaw count: 1

  • bad_bcd_links:
    • no explanation!

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

  • macros:
    • /en-US/docs/Web/API/WebGLRenderingContext/texParameterf redirects to /en-US/docs/Web/API/WebGLRenderingContext/texParameter
    • /en-US/docs/Web/API/WebGLRenderingContext/texParameteri redirects to /en-US/docs/Web/API/WebGLRenderingContext/texParameter

URL: /en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers
Title: Writing WebSocket servers
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/Server-Side_JavaScript

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

  • macros:
    • /en-US/docs/Web/API/WEBGL_compressed_texture_es3 redirects to /en-US/docs/Web/API/WEBGL_compressed_texture_etc

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

  • broken_links:
    • Can't resolve /en-US/docs/Web/Guide/Events/Event_handlers
    • Can't resolve /en-US/docs/Web/Guide/Events/Event_handlers

URL: /en-US/docs/Web/API/EXT_disjoint_timer_query
Title: EXT_disjoint_timer_query
on GitHub
Flaw count: 10

  • macros:
    • /en-US/docs/Web/API/EXT_disjoint_timer_query_webgl2 does not exist
    • /en-US/docs/Web/API/GetQueryObject does not exist
    • /en-US/docs/Web/API/GetQueryParameter does not exist
    • /en-US/docs/Web/API/GLint redirects to /en-US/docs/Web/API/WebGL_API/Types
    • /en-US/docs/Web/API/GLuint64EXT redirects to /en-US/docs/Web/API/WebGL_API/Types
    • and 5 more flaws omitted

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

  • macros:
    • /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types
    • /en-US/docs/Web/API/GLenum redirects to /en-US/docs/Web/API/WebGL_API/Types
    • /en-US/docs/Web/API/GLint redirects to /en-US/docs/Web/API/WebGL_API/Types
    • /en-US/docs/Web/API/GLint redirects to /en-US/docs/Web/API/WebGL_API/Types

URL: /en-US/docs/Web/API/Event/Comparison_of_Event_Targets
Title: Comparison of Event Targets
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/XBL/XBL_1.0_Reference/Anonymous_Content#Event_Flow_and_Targeting

URL: /en-US/docs/Web/API/Document_Object_Model
Title: Document Object Model (DOM)
on GitHub
Flaw count: 48

  • macros:
    • /en-US/docs/Web/API/SVGFilterPrimitiveStandardAttributes does not exist
    • /en-US/docs/Web/API/SVGHatchElement does not exist
    • /en-US/docs/Web/API/SVGHatchpathElement does not exist
    • /en-US/docs/Web/API/SVGMeshElement does not exist
    • /en-US/docs/Web/API/SVGMeshGradientElement does not exist
    • and 43 more flaws omitted

External URLs

URL: /en-US/docs/Web/API/Element/MozMousePixelScroll_event
Title: Element: MozMousePixelScroll event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Element/mousewheel_event
Title: Element: mousewheel event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/EXT_color_buffer_half_float
Title: EXT_color_buffer_half_float
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/KeyboardEvent/initKeyEvent
Title: KeyboardEvent.initKeyEvent()
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/OES_texture_half_float_linear
Title: OES_texture_half_float_linear
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/EXT_color_buffer_float
Title: EXT_color_buffer_float
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/EXT_frag_depth
Title: EXT_frag_depth
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/CloseEvent/initCloseEvent
Title: CloseEvent.initCloseEvent()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/UIEvent/initUIEvent
Title: UIEvent.initUIEvent()
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/WEBGL_lose_context
Title: WEBGL_lose_context
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/Clipboard
Title: Clipboard
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/HTMLElement/offsetParent
Title: HTMLElement.offsetParent
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/HTMLElement/dataset
Title: HTMLElement.dataset
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/PaymentCurrencyAmount/value
Title: PaymentCurrencyAmount.value
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/OES_standard_derivatives
Title: OES_standard_derivatives
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/AudioContext/createJavaScriptNode
Title: AudioContext.createJavaScriptNode()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Node/appendChild
Title: Node.appendChild()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Page_Visibility_API
Title: Page Visibility API
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/StorageManager/estimate
Title: StorageManager.estimate()
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/Navigation_timing_API
Title: Navigation Timing API
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers
Title: Writing WebSocket servers
on GitHub

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

No new external URLs

URL: /en-US/docs/Web/API/EXT_texture_compression_bptc
Title: EXT_texture_compression_bptc
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/OVR_multiview2
Title: OVR_multiview2
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/FileReader/readAsArrayBuffer
Title: FileReader.readAsArrayBuffer()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/FileReader/readAsText
Title: FileReader.readAsText()
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/EXT_float_blend
Title: EXT_float_blend
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/Window/open
Title: Window.open()
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/SVGAnimatedString/animVal
Title: SVGAnimatedString.animVal
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/Canvas_API/Tutorial/Transformations
Title: Transformations
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/API/Event/initEvent
Title: Event.initEvent()
on GitHub

No external URLs

URL: /en-US/docs/Web/API/Event/Comparison_of_Event_Targets
Title: Comparison of Event Targets
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Document_Object_Model
Title: Document Object Model (DOM)
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

@teoli2003 teoli2003 merged commit 46f662b into mdn:main Aug 23, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 23, 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

@sideshowbarker sideshowbarker Awaiting requested review from sideshowbarker

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