Page MenuHomePhabricator

MediaWiki core JSDoc cleanup
Closed, ResolvedPublic

Description

Tracking task for small fixes for the MediaWiki core JSDoc site

Typos

Use Markdown syntax for examples

Broken links

Link to private or ignored symbol https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1024817

External links that will be fixed by T359279

Missing descriptions

https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1021584

  • mw.Debug
  • mw.ForeignRest
  • mw.ForeignStructuredUpload
  • mw.Rest

https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1021601

  • mw.widgets.APIResultsProvider
  • mw.widgets.APIResultsQueue
  • mw.widgets.CalendarWidget
  • mw.widgets.CategoryMultiselectWidget
  • mw.widgets.CategoryTagItemWidget
  • mw.widgets.DateInputWidget
  • mw.widgets.ExpiryWidget
  • mw.widgets.MediaResourceProvider
  • mw.widgets.MediaResourceQueue
  • mw.widgets.MediaResultWidget
  • mw.widgets.MediaSearchProvider
  • mw.widgets.MediaSearchQueue
  • mw.widgets.MediaSearchWidget
  • mw.widgets.MediaUserUploadsProvider
  • mw.widgets.MediaUserUploadsQueue
  • mw.widgets.NamespacesMultiselectWidget
  • mw.widgets.RowWidgetModel
  • mw.widgets.SearchInputWidget
  • mw.widgets.TableWidgetModel
  • mw.widgets.TitleInputWidget
  • mw.widgets.TitleOptionWidget
  • mw.widgets.TitleSearchWidget
  • mw.widgets.TitlesMultiselectWidget
  • mw.widgets.UserInputWidget
  • https://doc.wikimedia.org/mediawiki-core/master/js/mw.widgets.SelectWithInputWidget.html

Descriptions to improve

https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1017344:

Out of scope

Missing descriptions

Event Timeline

Change #1014642 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Fix JSDoc syntax

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

Change #1014642 merged by jenkins-bot:

[mediawiki/core@master] docs: Fix JSDoc syntax

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

Change #1016049 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Fix JSDoc links

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

Change #1016049 merged by jenkins-bot:

[mediawiki/core@master] docs: Fix JSDoc links

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

Change #1017322 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Fix JSDoc links

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

Change #1017344 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Simplify JSDoc descriptions

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

Change #1017344 merged by jenkins-bot:

[mediawiki/core@master] docs: Simplify JSDoc descriptions

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

apaskulin triaged this task as High priority.

Change #1017322 merged by jenkins-bot:

[mediawiki/core@master] docs: Fix JSDoc links

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

Change #1024817 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Remove link syntax for non-working links

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

Change #1024868 had a related patch set uploaded (by Tacsipacsi; author: Tacsipacsi):

[mediawiki/core@master] docs: document $.fn.injectSpinner() with a typedef

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

apaskulin updated the task description. (Show Details)

@apaskulin There are two not yet merged patches, is this task really resolved?

oops! You're right. Re-opening

Change #1024868 merged by jenkins-bot:

[mediawiki/core@master] docs: document $.fn.injectSpinner() with a typedef

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

Change #1024817 merged by jenkins-bot:

[mediawiki/core@master] docs: Remove link syntax for non-working links

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