Page MenuHomePhabricator

Add a line after JSDoc block descriptions in mediawiki.notification
Closed, ResolvedPublic

Description

JSDoc expects an empty comment line after a block description.

For example:

correct
		/**
		 * For example `http` (always present).
                 *
		 * @name mw.Uri.prototype.protocol
		 * @type {string}
		 */
incorrect
		/**
		 * For example `http` (always present).
		 * @name mw.Uri.prototype.protocol
		 * @type {string}
		 */

To do:

  1. In the notification.js file, fix all the comment blocks so they conform to this convention.
  2. Run npm install grunt and grunt lint, and ensure that there are no warnings for this file

Event Timeline

Change #1027153 had a related patch set uploaded (by Sjoerddebruin; author: Sjoerddebruin):

[mediawiki/core@master] mediawiki.notification: Add a line after JSDoc block descriptions

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

Sjoerddebruin changed the task status from Open to In Progress.Sat, May 4, 2:34 PM
Sjoerddebruin moved this task from Backlog to Doing on the MediaWiki-core-Hackathon-2024 board.

Change #1027153 merged by jenkins-bot:

[mediawiki/core@master] mediawiki.notification: Add a line after JSDoc block descriptions

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