Background
In https://gerrit.wikimedia.org/r/c/mediawiki/extensions/EventLogging/+/754002 we replaced mw.eventLog.submit() with the Client Library implementation of submit and introduced .dispatch(), which is now deprecated. Regrettably, the same patch broke the public documentation for both methods.
Unfortunately, EventLogging uses JSDuck, which can't process the DocBlocks in the JS Client Library. AFAICT we have two options to fix the documentation:
- Copy the DocBlocks for MetricsClient#submit() and #dispatch() into EventLogging (here and here)
- Update EventLogging to use JSDoc and use @borrows tags to automatically copy the DocBlocks for MetricsClient#submit() and #dispatch() when the documentation is built and published
1 has the risk that the documentation for the mw.eventLog and MetricsClient methods could drift but would be significantly quicker than 2.
AC
- Documentation for mw.eventLog.submit() and .dispatch() is available via https://doc.wikimedia.org/EventLogging/master/js/mw.eventLog.html