Skip to content

onmidimessage event change#13664

Merged
teoli2003 merged 11 commits intomdn:mainfrom
Rumyra:onmidi
Mar 10, 2022
Merged

onmidimessage event change#13664
teoli2003 merged 11 commits intomdn:mainfrom
Rumyra:onmidi

Conversation

@Rumyra
Copy link
Collaborator

@Rumyra Rumyra commented Mar 8, 2022

Summary

onmidimessage should be midimessage_event

Motivation

Updating midi docs, so good chance to change the event pages - this pr tackles onmidimessage. This is my first go so am drafting and pinging @teoli2003 @Elchi3 or @queengooborg for review 🙏 (Also not I haven't checked bcd yet - I wasn't sure what comes first)

Metadata

  • Adds a new document
  • Rewrites (or significantly expands) a document
  • Fixes a typo, bug, or other error

Part of #12792

@Rumyra Rumyra requested review from a team as code owners March 8, 2022 17:00
@Rumyra Rumyra requested review from ddbeck and jpmedley and removed request for a team March 8, 2022 17:00
@Rumyra Rumyra marked this pull request as draft March 8, 2022 17:01
@github-actions github-actions bot added the Content:WebAPI Web API docs label Mar 8, 2022
@Rumyra Rumyra requested review from Elchi3 and teoli2003 and removed request for ddbeck and jpmedley March 8, 2022 17:02
@github-actions
Copy link
Contributor

github-actions bot commented Mar 8, 2022

Preview URLs

Flaws

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

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

  • bad_bcd_links:
    • no explanation!

URL: /en-US/docs/Web/API/MIDIInput/midimessage_event
Title: MIDIInput: midimessage event
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/Web/API/Web_MIDI_API

External URLs

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

No new external URLs


URL: /en-US/docs/Web/API/MIDIInput/midimessage_event
Title: MIDIInput: midimessage event
on GitHub


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

No new external URLs


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

No new external URLs


URL: /en-US/docs/Web/API/MIDIMessageEvent/data
Title: MIDIMessageEvent.data
on GitHub

No new external URLs

(this comment was updated 2022-03-10 13:53:07.917779)

@teoli2003
Copy link
Contributor

teoli2003 commented Mar 9, 2022

Checklist I used for reviewing this event Content PR:

When onXYZ exists, for each onXYZ

  • Redirect from /Web/API/xxxx/onXYZ to /Web/API/xxxx/XYZ_event` set
  • /Web/API/xxxx/onXYZ deleted.
  • In /Web/API/xxxx/XYZ_event:
    • Front-runner YAML: Correct browser-compat front-runner key
    • Front-runner YAML: Correct title front-runner key to: Interface: XYZ event (with ticks!)
    • Front-runner YAML: No Property and Event Handler int the tag list but Event in it (more cleaning possible)
    • Check if the event bubbles. If not, no mention in article
    • Intro explain the event itself and no more just onXYZ.

      Example: "The levelchange event of the Battery Status API is fired when the battery {{domxref("BatteryManager.level","level")}} property is updated."

    • No HTML table with Bubbles, Cancelable, and Interface lines.
    • Syntax section with the structure of the template, and fix the names of event and of the onXYZ property
    • If inheritance is not only Event, there is an Event type section (two texts possible!, with
      • {{InheritanceDiagram}} with the right argument
      • There is an Event properties section and list the parameters, taken from the interface of the event type
    • Check that no mention of this onXYZ is a link.
    • Check that links to other onXYZ are links to the corresponding XYZ_event

On the API interface page:

  • There is no Event handlers section
  • There is an Events section (with the correct events)
  • Check that there are no links to onXYZ.

On each page of the interface and the API overview page:

  • Check that there are no links to onXYZ.
  • Check that examples uses the modern syntax for defining function in event handler (onXYZ = event => { …} )
  • Check that no {{event} macro is left.
  • Fix flaws (as much as possible); at least, make sure not to introduce new flaws.
  • Check that if an event is linked to a property value, that property documents when this event is fired.

    Example: "When its value changes, the chargingchange event is fired."

Optional:

  • Remove gremlins (non-breaking spaces, curly tick, curly double-ticks)
  • If the interface is no more experimental, remove the experimental tags/banners.

Administration:

  • Link to the BCD PR.

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.

This is really good. A few nit and a couple of things to move around.

Rumyra and others added 9 commits March 10, 2022 09:53
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
@Rumyra
Copy link
Collaborator Author

Rumyra commented Mar 10, 2022

I think I've address everything @teoli2003 I just need to take a look at bcd next 👍

@Rumyra Rumyra requested a review from teoli2003 March 10, 2022 12:01
@Rumyra Rumyra marked this pull request as ready for review March 10, 2022 12:02
Co-authored-by: Jean-Yves Perrier <jypenator@gmail.com>
@teoli2003 teoli2003 merged commit b278042 into mdn:main Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:WebAPI Web API docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants