Page MenuHomePhabricator

Use JSDoc method tags instead of function tags
Closed, ResolvedPublic

Description

In JSDoc comments for Wikimedia codebases, the convention is to use @method instead of @function.

To do:

  1. In the mw.widgets.TitleWidget.js file, replace @function with @method in line 92
  2. In the mediawiki.requestIdleCallback.js file, replace @function with @method in line 40
  3. Run npm install grunt and grunt lint, and ensure that no JSDoc warnings are reported for either of these file

Details

Related Changes in Gerrit:

Event Timeline

apaskulin renamed this task from Use JSDoc method tag for mw.widgets.TitleWidget.prototype.getQueryValue to Use JSDoc method tags instead of function tags.Apr 25 2024, 11:34 PM
apaskulin updated the task description. (Show Details)
Baderayat claimed this task.
Pppery added a subscriber: Baderayat.

Using the following command to run grunt:

mw dev mw fresh -- npx grunt lint

Change #1025924 had a related patch set uploaded (by Siebrand; author: Siebrand):

[mediawiki/core@master] Use JSDoc tag method instead of function

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

Change #1025924 merged by jenkins-bot:

[mediawiki/core@master] Use JSDoc tag method instead of function

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