OO.ui.InputWidget.prototype.getInputElement has a config parameter in its documentation, but not in its implementation (because it's only used in subclasses)
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Amire80
	Jan 27 2015, 3:11 PM

Description

I was trying to understand how OOjs-UI input widgets work, and found this code:

/**
 * Get input element.
 *
 * @private
 * @param {Object} [config] Configuration options
 * @return {jQuery} Input element
 */
OO.ui.InputWidget.prototype.getInputElement = function () {
	return this.$( '<input>' );
};

Is the config parameter needed here? I suspect that it is, but I might be wrong.

Details

	Subject	Repo	Branch	Lines +/-
	InputWidget: Clarify documentation of #getInputElement	oojs/ui	master	+9 -23

Customize query in gerrit

Related Objects

Mentioned In: rGOJU816a891dae90: InputWidget: Clarify documentation of #getInputElement
T87648: OO.ui.InputWidget() passes config to OO.ui.CheckboxInputWidget.prototype.getInputElement(), and this parameter is ignored
Mentioned Here: T87648: OO.ui.InputWidget() passes config to OO.ui.CheckboxInputWidget.prototype.getInputElement(), and this parameter is ignored

Event Timeline

Amire80 created this task.Jan 27 2015, 3:11 PM

Amire80 raised the priority of this task from to Needs Triage.

Amire80 updated the task description. (Show Details)

Amire80 added a project: OOUI.

Amire80 subscribed.

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJan 27 2015, 3:11 PM

Esanders subscribed.Jan 28 2015, 1:27 AM

This comment was removed by Esanders.

We document parameters that can be passed but if they are not used by the method we don't include them in the arguments list.

matmarex claimed this task.Jan 28 2015, 10:49 AM

Yes, this is expected. We do use the config parameter in two InputWidget subclasses: ButtonInputWidget and TextInputWidget. This looks a bit weird, but it's a limitation of JSDuck documentation system, and I don't think we can work around it without the docs in subclasses becoming messed up.

Thank you for the diligence!

matmarex triaged this task as Medium priority.Jan 28 2015, 10:28 PM

matmarex merged a task: T87648: OO.ui.InputWidget() passes config to OO.ui.CheckboxInputWidget.prototype.getInputElement(), and this parameter is ignored.

matmarex mentioned this in T87648: OO.ui.InputWidget() passes config to OO.ui.CheckboxInputWidget.prototype.getInputElement(), and this parameter is ignored.

matmarex subscribed.

Change 187256 had a related patch set uploaded (by Bartosz Dziewoński):
InputWidget: Clarify documentation of #getInputElement

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

Patch-For-Review

matmarex renamed this task from OO.ui.InputWidget.prototype.getInputElement has a config parameter in its documentation, but not in its implementation to OO.ui.InputWidget.prototype.getInputElement has a config parameter in its documentation, but not in its implementation (because it's only used in subclasses).Jan 28 2015, 10:40 PM

matmarex set Security to None.

matmarex moved this task from Backlog to Next-up on the OOUI board.

matmarex moved this task from Next-up to Doing on the OOUI board.

Change 187256 merged by jenkins-bot:
InputWidget: Clarify documentation of #getInputElement

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

Jdforrester-WMF closed this task as Resolved.Jan 29 2015, 1:56 AM

Jdforrester-WMF edited projects, added WMF-deploy-2015-02-04_(1.25wmf16); removed Patch-For-Review.

matmarex mentioned this in rGOJU816a891dae90: InputWidget: Clarify documentation of #getInputElement.Mar 3 2015, 7:49 PM

Jdforrester-WMF moved this task from Doing to Reviewing on the OOUI board.Mar 26 2015, 8:59 PM

OO.ui.InputWidget.prototype.getInputElement has a config parameter in its documentation, but not in its implementation (because it's only used in subclasses)Closed, ResolvedPublicActions

Description

Details

Related Objects

Event Timeline

OO.ui.InputWidget.prototype.getInputElement has a config parameter in its documentation, but not in its implementation (because it's only used in subclasses)
Closed, ResolvedPublic
Actions