jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/352956 )
Change subject: Fix some errors flagged by ESLint's 'valid-jsdoc' option ...................................................................... Fix some errors flagged by ESLint's 'valid-jsdoc' option We disable the 'valid-jsdoc' option because it doesn't understand that @chainable can be used instead of @return. This feature request was rejected upstream: <https://github.com/eslint/eslint/issues/6681>. But there are some useful errors it flags not related to @return tags. I'm fixing them here. grunt lint | grep -v "Missing JSDoc @returns for function" Change-Id: Id117fc662b8457fb8f64fe744feefc12cf73eddc --- M src/widgets/MenuTagMultiselectWidget.js M src/widgets/TagItemWidget.js M src/widgets/TagMultiselectWidget.js 3 files changed, 5 insertions(+), 4 deletions(-) Approvals: jenkins-bot: Verified VolkerE: Looks good to me, approved diff --git a/src/widgets/MenuTagMultiselectWidget.js b/src/widgets/MenuTagMultiselectWidget.js index e355378..05f1064 100644 --- a/src/widgets/MenuTagMultiselectWidget.js +++ b/src/widgets/MenuTagMultiselectWidget.js @@ -188,7 +188,7 @@ /** * Add options to the menu * - * @param {Object[]} options Object defining options + * @param {Object[]} menuOptions Object defining options */ OO.ui.MenuTagMultiselectWidget.prototype.addOptions = function ( menuOptions ) { var widget = this, diff --git a/src/widgets/TagItemWidget.js b/src/widgets/TagItemWidget.js index 7c74cc3..109e97e 100644 --- a/src/widgets/TagItemWidget.js +++ b/src/widgets/TagItemWidget.js @@ -131,6 +131,7 @@ * * @fires navigate * @fires remove + * @param {jQuery.Event} e Key down event * @return {boolean|undefined} false to stop the operation */ OO.ui.TagItemWidget.prototype.onKeyDown = function ( e ) { diff --git a/src/widgets/TagMultiselectWidget.js b/src/widgets/TagMultiselectWidget.js index 8d7f884..50380c3 100644 --- a/src/widgets/TagMultiselectWidget.js +++ b/src/widgets/TagMultiselectWidget.js @@ -348,7 +348,6 @@ * Perform an action after the escape key on the input * * @param {jQuery.Event} e Event data - * @return {boolean} Whether to prevent defaults */ OO.ui.TagMultiselectWidget.prototype.doInputEscape = function () { this.clearInput(); @@ -363,7 +362,6 @@ * @param {string} direction Direction of the movement; forwards or backwards * @param {boolean} [withMetaKey] Whether this key was pressed with * a meta key like 'ctrl' - * @return {boolean} Whether to prevent defaults */ OO.ui.TagMultiselectWidget.prototype.doInputArrow = function ( e, direction ) { if ( @@ -382,6 +380,8 @@ /** * Respond to item select event + * + * @param {OO.ui.TagItemWidget} item Selected item */ OO.ui.TagMultiselectWidget.prototype.onTagSelect = function ( item ) { if ( this.hasInput && this.allowEditTags ) { @@ -561,7 +561,7 @@ /** * Set the value of this widget by datas. * - * @param {string|string[]|Object|Object[]} value An object representing the data + * @param {string|string[]|Object|Object[]} valueObject An object representing the data * and label of the value. If the widget allows arbitrary values, * the items will be added as-is. Otherwise, the data value will * be checked against allowedValues. -- To view, visit https://gerrit.wikimedia.org/r/352956 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Id117fc662b8457fb8f64fe744feefc12cf73eddc Gerrit-PatchSet: 1 Gerrit-Project: oojs/ui Gerrit-Branch: master Gerrit-Owner: Bartosz Dziewoński <[email protected]> Gerrit-Reviewer: VolkerE <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
