LabelElement: 'labelChange' event missing documented parameter `value`
Closed, ResolvedPublicBUG REPORT
Actions

Assigned To

Authored By

	DannyS712
	Sep 11 2021, 1:41 AM

Description

The labelChange event in LabelElement is documented[1] as having a parameter, @param {string} value.
However, the two places that trigger the event do so without any parameters[2][3], just this.emit( 'labelChange' );.
Either the parameter should be added, or the documentation corrected.

[1] https://gerrit.wikimedia.org/g/oojs/ui/+/9cbee0a5b5132a8ea0388a058002c23ee01de404/src/mixins/LabelElement.js#44
[2] https://gerrit.wikimedia.org/g/oojs/ui/+/9cbee0a5b5132a8ea0388a058002c23ee01de404/src/mixins/LabelElement.js#177
[3] https://gerrit.wikimedia.org/g/oojs/ui/+/9cbee0a5b5132a8ea0388a058002c23ee01de404/src/mixins/LabelElement.js#197

Details

	Subject	Repo	Branch	Lines +/-
	Update OOUI to v0.42.1	mediawiki/core	master	+281 -212
	LabelElement: Remove non-existent parameter from 'labelChange' event doc	oojs/ui	master	+0 -1

Customize query in gerrit

Related Objects

Mentioned In: T290791: Add an image: guidance content

Event Timeline

DannyS712 created this task.Sep 11 2021, 1:41 AM

Restricted Application added a project: User-DannyS712. · View Herald TranscriptSep 11 2021, 1:41 AM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

DannyS712 changed the subtype of this task from "Task" to "Bug Report".Sep 11 2021, 1:42 AM

DannyS712 moved this task from Unsorted to Reports on the User-DannyS712 board.

It was not meant to have a parameter, this was probably copied from the 'change' event by mistake.

Change 722636 had a related patch set uploaded (by Bartosz Dziewoński; author: Bartosz Dziewoński):

[oojs/ui@master] LabelElement: Remove non-existent parameter from 'labelChange' event doc

https://gerrit.wikimedia.org/r/722636

gerritbot added a project: Patch-For-Review.Sep 21 2021, 2:47 PM

Change 722636 merged by jenkins-bot:

[oojs/ui@master] LabelElement: Remove non-existent parameter from 'labelChange' event doc

https://gerrit.wikimedia.org/r/722636

Volker_E closed this task as Resolved.Sep 21 2021, 3:04 PM

Volker_E triaged this task as Low priority.

Volker_E moved this task from Backlog to OOUI-0.42.1 on the OOUI board.

Volker_E edited projects, added OOUI (OOUI-0.42.1); removed OOUI.

Volker_E edited projects, added Documentation; removed Patch-For-Review.

Change 736621 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/core@master] Update OOUI to v0.42.1

https://gerrit.wikimedia.org/r/736621

gerritbot added a project: Patch-For-Review.Nov 4 2021, 2:10 AM

Change 736621 merged by jenkins-bot: