Fix documentation for Context methods (OT)
Closed, ResolvedPublic2 Estimated Story Points
Actions

Assigned To

Authored By

	Tchanders
	Feb 1 2021, 1:38 PM

Description

The method Context::getElection can return an Election object or false; however, it is documented only to return an Election object.

The documentation should be fixed to say:

@return Election|bool

The @return documentation for Context::getElectionByTitle and Context::newFromXmlFile should also be fixed to say bool instead of false.

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Fix documentation for Context functions	mediawiki/extensions/SecurePoll	master	+2 -2
	Fix documentation for Context methods	mediawiki/extensions/SecurePoll	master	+1 -1

Customize query in gerrit

Event Timeline

Tchanders created this task.Feb 1 2021, 1:38 PM

Restricted Application added a project: Platform Engineering. · View Herald TranscriptFeb 1 2021, 1:38 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

• AMooney removed a project: Platform Engineering.Feb 1 2021, 5:53 PM

Niharika set the point value for this task to 2.Feb 11 2021, 5:28 PM

Tchanders moved this task from Onboarding Tasks to The Letter Song on the Anti-Harassment-Team board.Feb 11 2021, 6:31 PM

Tchanders edited projects, added Anti-Harassment-Team (The Letter Song); removed Anti-Harassment-Team.

• AGueyte claimed this task.Feb 12 2021, 3:00 PM

• AGueyte moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment-Team (The Letter Song) board.Feb 12 2021, 5:54 PM

Change 664837 had a related patch set uploaded (by AGueyte; owner: AGueyte):
[mediawiki/extensions/SecurePoll@master] Fix documentation for Context methods

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

gerritbot added a project: Patch-For-Review.Feb 17 2021, 3:47 PM

Change 664837 merged by jenkins-bot:
[mediawiki/extensions/SecurePoll@master] Fix documentation for Context methods

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

ReleaseTaggerBot added a project: MW-1.36-notes (1.36.0-wmf.32; 2021-02-23).Feb 17 2021, 4:00 PM

Maintenance_bot removed a project: Patch-For-Review.Feb 17 2021, 4:10 PM

@AGueyte Thanks for fixing this - I see it's been merged!

Would you mind also fixing the documentation for Context::getElectionByTitle and Context::newFromXmlFile to say bool instead of false? It can be in a new commit, tagged against this task.

Tchanders moved this task from In Progress 💪 to Done: Q3 (2020-2021) on the Anti-Harassment-Team (The Letter Song) board.Feb 17 2021, 8:12 PM

Tchanders moved this task from Done: Q3 (2020-2021) to In Progress 💪 on the Anti-Harassment-Team (The Letter Song) board.

Change 665351 had a related patch set uploaded (by AGueyte; owner: AGueyte):
[mediawiki/extensions/SecurePoll@master] Fix documentation for Context functions

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

gerritbot added a project: Patch-For-Review.Feb 19 2021, 3:12 PM

• AGueyte moved this task from In Progress 💪 to Code Review 🔍 on the Anti-Harassment-Team (The Letter Song) board.Feb 19 2021, 3:39 PM

Change 665351 merged by jenkins-bot:
[mediawiki/extensions/SecurePoll@master] Fix documentation for Context functions

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

Maintenance_bot removed a project: Patch-For-Review.Feb 19 2021, 5:10 PM

Tchanders moved this task from Code Review 🔍 to Done: Q3 (2020-2021) on the Anti-Harassment-Team (The Letter Song) board.Feb 19 2021, 6:02 PM

Niharika closed this task as Resolved.Feb 22 2021, 12:45 PM