Page MenuHomePhabricator

Community tech: Review stable code (hooks, mw object, undocumented) and mark (un)stable interfaces before 1.42.0
Closed, ResolvedPublic

Description

The stable interface policy was introduced in September 2023 during the 1.41 MediaWiki release. As a result of the introduction of this policy I am asking teams to take the opportunity to review their existing stable APIs and take appropriate action to limit unsupported APIs where necessary and possible.

TODO

  • Please read the guidelines around what constitutes stable code
  • Please remove any functions on the mw object that you do not wish to consider stable. Note "Code that was never part of a public MediaWiki release, and never consumed according to Codesearch and Global Search MAY be changed (including marked explicitly as @private) or removed without deprecation, since the code has never become part of the stable interface or used."
  • Please add @private or @internal documentation tags to hook events that you wish to limit usage of.

Event Timeline

Jdlrobson renamed this task from Community tech: Review code on mw object and mark (un)stable interfaces before 1.42.0 to Community tech: Review stable code (hooks, mw object, undocumented) and mark (un)stable interfaces before 1.42.0.Oct 4 2023, 4:45 PM

Change 966565 had a related patch set uploaded (by MusikAnimal; author: MusikAnimal):

[mediawiki/core@master] mediawiki.page.preview: mark @stable and make parentheseWrap() private

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

Change 966565 merged by jenkins-bot:

[mediawiki/core@master] mediawiki.page.preview: mark @stable and make parentheseWrap() private

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

This is done for our code in Core and MediaWiki-extensions-CodeMirror. There are two hooks in MediaWiki-extensions-TemplateWizard that I believe we want to consider stable, but we do not need to explicitly add the @stable tag.

Resolving.