Maniphest T159082

Documentation improvements for the Newsletter extension
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	01tonythomas
	Feb 26 2017, 8:11 PM

Tags

Referenced Files

None

Subscribers

Description

In T115095#3004776, @Bawolff wrote:

Review of 631882e3779 of Newsletter extension (Jan 29, 2017)

* "NewsletterDb.php" line 439 - newsletterExistsForMainPage() says it could return boolean? How? - done in https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Newsletter/+/755842

onAlternateEdit() - There's no documentation here despite it being very non-obvious what's going on with the interplay between onAlternateEdit() and onCustomEditor(). In fact, I can't tell. Does the onAlternateEdit hook actually do anything?

It should be documented why the onContentModelCanBeUsed on hook is being used instead of overriding canBeUsedOn().

* "NewsletterStore.php" line 22 - @var static is wrong. - done in https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Newsletter/+/482095

Details

	Subject	Repo	Branch	Lines +/-
	Remove dead code and improve documentation	mediawiki/extensions/Newsletter	master	+3 -25

Customize query in gerrit

Related Objects

Mentioned In: T115095: Security review of Newsletter extension
Mentioned Here: rENLT631882e3779c: Localisation updates from https://translatewiki.net.
T115095: Security review of Newsletter extension

Event Timeline

01tonythomas created this task.Feb 26 2017, 8:11 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 26 2017, 8:11 PM

01tonythomas mentioned this in T115095: Security review of Newsletter extension.Feb 26 2017, 8:16 PM

Aklapper added a project: Documentation.Feb 27 2017, 10:43 AM

Srijancse subscribed.Feb 28 2017, 5:47 AM

Trizek-WMF moved this task from Backlog to For MediaWiki users on the Documentation board.Nov 27 2017, 9:39 AM

• srodlund moved this task from For MediaWiki users to New Technical Documentation Request on the Documentation board.Aug 14 2018, 7:41 PM

Pppery updated the task description. (Show Details)Jun 25 2023, 3:00 PM

Pppery updated the task description. (Show Details)Jun 25 2023, 3:04 PM

Pppery claimed this task.Jun 25 2023, 3:13 PM

Change 932667 had a related patch set uploaded (by Pppery; author: Pppery):

[mediawiki/extensions/Newsletter@master] Remove dead code and improve documentation

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

gerritbot added a project: Patch-For-Review.Jun 25 2023, 3:17 PM

Change 932667 merged by jenkins-bot:

[mediawiki/extensions/Newsletter@master] Remove dead code and improve documentation

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

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.16; 2023-07-04).Jun 27 2023, 11:00 AM

Maintenance_bot removed a project: Patch-For-Review.Jun 27 2023, 11:10 AM

Pppery closed this task as Resolved.Jun 27 2023, 1:02 PM