Page MenuHomePhabricator

Add more doc annotations to LanguageConverter related classes
Closed, ResolvedPublic

Description

After merging of the patch: https://gerrit.wikimedia.org/r/c/mediawiki/core/+/564789 a few comments came from @Krinkle
ILanguageConverter.php

  1. needs @ingroup.
  2. Also, being a new Language-related class ILanguageConverter should be in includes/language instead of the old languages/.

LanguageConverterFactory:

  1. needs @ingroup.
  2. need license header

TrivialLanguageConverter.php

  1. need @since

LinkHolderArray.php

  1. should be marked @internal and announced in the release notes.

This is a breaking change. Assuming that is intentional, please mark it as such in the release notes and notify Wikitech-l.
Alternatively, remove it from the public interface by making as @internal to parser/ (and add release notes).
It's technically a breaking change per the old policy, but it's unused, and wouldn't be part of the public interface per the new policy. I don't think announcement on wikitech-l is necessary.

Details

Related Gerrit Patches:

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 10 2020, 10:25 AM
Peter.ovchyn renamed this task from LanguageConverter related follow-up after final review. to LanguageConverter small follow-ups after final review.Feb 10 2020, 10:26 AM

@Peter.ovchyn: Assuming this task is about MediaWiki-Language-converter, hence adding project tag so others can find this task when searching for tasks under that project.

Change 571288 had a related patch set uploaded (by Peter.ovchyn; owner: Peter.ovchyn):
[mediawiki/core@master] languages: More annotations for LanguageConverter related classes

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

Peter.ovchyn renamed this task from LanguageConverter small follow-ups after final review to Add more doc annotations to LanguageConverter related classes.Feb 10 2020, 2:25 PM

Change 571288 merged by jenkins-bot:
[mediawiki/core@master] languages: More doc annotations for LanguageConverter related classes

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

Peter.ovchyn closed this task as Resolved.Mar 3 2020, 6:03 PM