jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/404489 )
Change subject: Minor documentation cleanup
......................................................................
Minor documentation cleanup
Bug: T184775
Change-Id: I883a2ebc0a1ce7667a92623a4861be80df26a65d
---
M tests/phpunit/maintenance/MaintenanceTest.php
1 file changed, 16 insertions(+), 14 deletions(-)
Approvals:
Ladsgroup: Looks good to me, approved
jenkins-bot: Verified
diff --git a/tests/phpunit/maintenance/MaintenanceTest.php
b/tests/phpunit/maintenance/MaintenanceTest.php
index e21e726..253327b 100644
--- a/tests/phpunit/maintenance/MaintenanceTest.php
+++ b/tests/phpunit/maintenance/MaintenanceTest.php
@@ -1,29 +1,31 @@
<?php
-// It would be great if we were able to use PHPUnit's getMockForAbstractClass
-// instead of the MaintenanceFixup hack below. However, we cannot do
-// without changing the visibility and without working around hacks in
-// Maintenance.php
-// For the same reason, we cannot just use FakeMaintenance.
use MediaWiki\MediaWikiServices;
/**
- * makes parts of the API of Maintenance that is hidden by protected visibily
- * visible for testing, and makes up for a stream closing hack in
Maintenance.php.
+ * Makes parts of Maintenance class API visible for testing, and makes up for a
+ * stream closing hack in Maintenance.php.
*
* This class is solely used for being able to test Maintenance right now
* without having to apply major refactorings to fix some design issues in
* Maintenance.php. Before adding more functions here, please consider whether
- * this approach is correct, or a refactoring Maintenance to separate concers
+ * this approach is correct, or a refactoring Maintenance to separate concerns
* is more appropriate.
*
- * Upon refactoring, keep in mind that besides the maintenance scrits
themselves
- * and tests right here, also at least Extension:Maintenance make use of
- * Maintenance.
+ * Upon refactoring, keep in mind that besides the maintenance scripts
themselves
+ * and tests right here, some extensions including Extension:Maintenance make
+ * use of the Maintenance class.
*
* Due to a hack in Maintenance.php using register_shutdown_function, be sure
to
- * finally call simulateShutdown on MaintenanceFixup instance before a test
- * ends.
+ * call simulateShutdown on MaintenanceFixup instance before a test ends.
+ *
+ * FIXME:
+ * It would be great if we were able to use PHPUnit's getMockForAbstractClass
+ * instead of the MaintenanceFixup hack below. However, we cannot do so
+ * without changing method visibility and without working around hacks in
+ * Maintenance.php
+ *
+ * For the same reason, we cannot just use FakeMaintenance.
*/
class MaintenanceFixup extends Maintenance {
@@ -42,7 +44,7 @@
private $testCase;
/**
- * shutdownSimulated === true if simulateShutdown has done it's work
+ * shutdownSimulated === true if simulateShutdown has done its work
*
* @var bool
*/
--
To view, visit https://gerrit.wikimedia.org/r/404489
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I883a2ebc0a1ce7667a92623a4861be80df26a65d
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Awight <[email protected]>
Gerrit-Reviewer: Awight <[email protected]>
Gerrit-Reviewer: Ladsgroup <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
