Page MenuHomePhabricator

Replace jsduck with JSDoc3 in Translate
Open, MediumPublic2 Estimated Story Points

Description

  • eliminate 8 excludes statements in jsdoc.json (and the errors causing them to be excluded)
  • fix npm run doc warnings
    • The @inheritdoc tag does not permit a value; the value will be ignored. File: LanguagesMultiselectWidget.js x10
    • WARNING: No contribution link found (in package.json>repository.url, or jsdoc.json>templates.wmf.repository)
  • convert README to README.md (markdown), so that /doc/index.html is readable
  • check for missing classes and methods
    • RenameDropdown methods
    • GroupSynchronization class & methods
    • more?
  • check for and fix doc-related linter errors. (add npm run lint to facilitate this)

Event Timeline

Change #1034111 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/Translate@master] JSDoc: initial setup

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

Change #1037534 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/Translate@master] JSDoc: fix linter warnings

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

Change #1037537 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/Translate@master] JSDoc: get missing RenameDropdown methods to show up in /docs/

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

Change #1037540 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/Translate@master] JSDoc: add class GroupSynchronization

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

Change #1034111 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] JSDoc: initial setup

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

Change #1037534 merged by jenkins-bot:

[mediawiki/extensions/Translate@master] JSDoc: fix linter warnings

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

Change #1037540 abandoned by Novem Linguae:

[mediawiki/extensions/Translate@master] JSDoc: add class GroupSynchronization

Reason:

I've been informed that we should only set up JSDoc sites for extensions that previously had JSDuck. This one did not. Going to save reviewers some time and abandon/rollback my patches related to JSDoc for Extension:Translate.

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

Change #1037537 abandoned by Novem Linguae:

[mediawiki/extensions/Translate@master] JSDoc: get missing RenameDropdown methods to show up in /docs/

Reason:

I've been informed that we should only set up JSDoc sites for extensions that previously had JSDuck. This one did not. Going to save reviewers some time and abandon/rollback my patches related to JSDoc for Extension:Translate.

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

Change #1040568 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/Translate@master] Revert "JSDoc: initial setup"

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

Change #1040568 abandoned by Novem Linguae:

[mediawiki/extensions/Translate@master] Revert "JSDoc: initial setup"

Reason:

Team wants to keep JSDoc

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

Novem_Linguae updated the task description. (Show Details)