From 4b7107764668118b181b7f569494a4fcbe8c89d7 Mon Sep 17 00:00:00 2001 From: Thiemo Kreuz Date: Wed, 9 Jan 2019 17:15:21 +0100 Subject: [PATCH] Remove a few obscure "done" and "empty" comments These don't add any knowledge to what is already obvious from the code, I find. Change-Id: Ia613b6a059f78dbeefdfd020899bd1a6e239a731 --- includes/FileDeleteForm.php | 1 - includes/Storage/PageUpdater.php | 4 ++-- includes/block/BlockRestriction.php | 1 - includes/diff/DifferenceEngine.php | 2 +- includes/logging/LogPage.php | 2 +- includes/revisiondelete/RevisionDeleteUser.php | 1 - maintenance/Maintenance.php | 1 - maintenance/cleanupEmptyCategories.php | 2 -- maintenance/cleanupPreferences.php | 1 - maintenance/deleteOldRevisions.php | 1 - maintenance/importImages.php | 1 - tests/phpunit/includes/filebackend/FileBackendTest.php | 4 ++-- 12 files changed, 6 insertions(+), 15 deletions(-) diff --git a/includes/FileDeleteForm.php b/includes/FileDeleteForm.php index 3e0595ebe4..8866a88bda 100644 --- a/includes/FileDeleteForm.php +++ b/includes/FileDeleteForm.php @@ -229,7 +229,6 @@ class FileDeleteForm { $lbFactory->rollbackMasterChanges( __METHOD__ ); } } else { - // Done; nothing changed $dbw->endAtomic( __METHOD__ ); } } diff --git a/includes/Storage/PageUpdater.php b/includes/Storage/PageUpdater.php index 6cbdcc6e91..e25f0f06dd 100644 --- a/includes/Storage/PageUpdater.php +++ b/includes/Storage/PageUpdater.php @@ -1104,10 +1104,10 @@ class PageUpdater { // TODO: move to storage service $newid = $wikiPage->insertOn( $dbw ); if ( $newid === false ) { - $dbw->endAtomic( __METHOD__ ); // nothing inserted + $dbw->endAtomic( __METHOD__ ); $status->fatal( 'edit-already-exists' ); - return $status; // nothing done + return $status; } // At this point we are now comitted to returning an OK diff --git a/includes/block/BlockRestriction.php b/includes/block/BlockRestriction.php index b5574f9fe8..72f6eaa9b6 100644 --- a/includes/block/BlockRestriction.php +++ b/includes/block/BlockRestriction.php @@ -149,7 +149,6 @@ class BlockRestriction { $restrictions ); - // Nothing to remove. if ( empty( $restrictionsToRemove ) ) { continue; } diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php index 8ca480f796..8540756d31 100644 --- a/includes/diff/DifferenceEngine.php +++ b/includes/diff/DifferenceEngine.php @@ -1463,7 +1463,7 @@ class DifferenceEngine extends ContextSource { return self::intermediateEditsMsg( $nEdits, $numUsers, $limit ); } - return ''; // nothing + return ''; } /** diff --git a/includes/logging/LogPage.php b/includes/logging/LogPage.php index b63f818155..45d6e1fe99 100644 --- a/includes/logging/LogPage.php +++ b/includes/logging/LogPage.php @@ -385,7 +385,7 @@ class LogPage { */ public function addRelations( $field, $values, $logid ) { if ( !strlen( $field ) || empty( $values ) ) { - return false; // nothing + return false; } $data = []; diff --git a/includes/revisiondelete/RevisionDeleteUser.php b/includes/revisiondelete/RevisionDeleteUser.php index 19fe0c3255..34b624fce2 100644 --- a/includes/revisiondelete/RevisionDeleteUser.php +++ b/includes/revisiondelete/RevisionDeleteUser.php @@ -191,7 +191,6 @@ class RevisionDeleteUser { __METHOD__ ); - # Done! return true; } diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php index e76426d01a..71d12ee0bc 100644 --- a/maintenance/Maintenance.php +++ b/maintenance/Maintenance.php @@ -1326,7 +1326,6 @@ abstract class Maintenance { $this->output( "done.\n" ); } - # Done $this->commitTransaction( $dbw, __METHOD__ ); } diff --git a/maintenance/cleanupEmptyCategories.php b/maintenance/cleanupEmptyCategories.php index 786c20a59e..922b32e50f 100644 --- a/maintenance/cleanupEmptyCategories.php +++ b/maintenance/cleanupEmptyCategories.php @@ -116,7 +116,6 @@ TEXT ] ); if ( !$rows || $rows->numRows() <= 0 ) { - # Done, hopefully. break; } @@ -170,7 +169,6 @@ TEXT ] ); if ( !$rows || $rows->numRows() <= 0 ) { - # Done, hopefully. break; } foreach ( $rows as $row ) { diff --git a/maintenance/cleanupPreferences.php b/maintenance/cleanupPreferences.php index b24d72ddda..a52ce17565 100644 --- a/maintenance/cleanupPreferences.php +++ b/maintenance/cleanupPreferences.php @@ -118,7 +118,6 @@ class CleanupPreferences extends Maintenance { $numRows = $res->numRows(); $total += $numRows; if ( $res->numRows() <= 0 ) { - // All done! $this->output( "DONE! (handled $total entries)\n" ); break; } diff --git a/maintenance/deleteOldRevisions.php b/maintenance/deleteOldRevisions.php index fc43e220e4..56576d908f 100644 --- a/maintenance/deleteOldRevisions.php +++ b/maintenance/deleteOldRevisions.php @@ -90,7 +90,6 @@ class DeleteOldRevisions extends Maintenance { $this->output( "done.\n" ); } - # This bit's done # Purge redundant text records $this->commitTransaction( $dbw, __METHOD__ ); if ( $delete ) { diff --git a/maintenance/importImages.php b/maintenance/importImages.php index 5db1fa89c4..7a2e0f405f 100644 --- a/maintenance/importImages.php +++ b/maintenance/importImages.php @@ -335,7 +335,6 @@ class ImportImages extends Maintenance { $props, $timestamp )->isOK() ) { - # We're done! $this->output( "done.\n" ); $doProtect = false; diff --git a/tests/phpunit/includes/filebackend/FileBackendTest.php b/tests/phpunit/includes/filebackend/FileBackendTest.php index f570f55329..4dc2f9e0ca 100644 --- a/tests/phpunit/includes/filebackend/FileBackendTest.php +++ b/tests/phpunit/includes/filebackend/FileBackendTest.php @@ -350,7 +350,7 @@ class FileBackendTest extends MediaWikiTestCase { $this->assertEquals( false, $this->backend->fileExists( [ 'src' => $dest ] ), "Destination file $dest does not exist ($backendName)." ); - return; // done + return; } $status = $this->backend->doOperation( @@ -470,7 +470,7 @@ class FileBackendTest extends MediaWikiTestCase { $this->assertEquals( false, $this->backend->fileExists( [ 'src' => $dest ] ), "Destination file $dest does not exist ($backendName)." ); - return; // done + return; } $status = $this->backend->doOperation( -- 2.20.1