Last modified: 2013-03-20 17:03:13 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T47872, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 45872 - VisualEditor: Clean up inconsistent documentation of event emissions
VisualEditor: Clean up inconsistent documentation of event emissions
Status: RESOLVED FIXED
Product: VisualEditor
Classification: Unclassified
Technical Debt (Other open bugs)
unspecified
All All
: Normal normal
: VE-deploy-2013-04-01
Assigned To: Krinkle
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2013-03-08 01:36 UTC by Roan Kattouw
Modified: 2013-03-20 17:03 UTC (History)
3 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Roan Kattouw 2013-03-08 01:36:12 UTC
Some events are undocumented (like ve.dm.Surface.prototype.change, which emits multiple events but documents none), most have the event name without quotes, but some have single quotes (ve.dm.Surface.addInsertionAnnotation) or double quotes (ve.ui.Toolbar.prototype.onContextChange). Parameters sometimes are documented and sometimes aren't, there's no clear distinction between "parameters aren't documented" and "there aren't any", and in no case do we document the types and descriptions of event parameters, we only ever document their names.

We probably also don't document events with @event nearly as often as we should. It's a huge mess.
Comment 1 Krinkle 2013-03-20 06:53:54 UTC
Working on it.
Comment 2 Krinkle 2013-03-20 07:11:04 UTC
Change-Id: Id879aa769b2c72d86a0322e75dddeb868211ce28

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links