From: umherirrender Date: Wed, 23 Jul 2014 20:04:48 +0000 (+0200) Subject: Standardize @todo X-Git-Tag: 1.31.0-rc.0~14799^2 X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=abfa0d7854db8d785afaedd5d3a64d89b78f3cf3;p=lhc%2Fweb%2Fwiklou.git Standardize @todo Always use lowercase @todo Changed some "@FIXME" to "@todo FIXME: " Change-Id: I016d1f9511e6f3bbd22427f0fffeccd77ab5e0db --- diff --git a/includes/MediaWiki.php b/includes/MediaWiki.php index a8bafa3f46..1c245c1db9 100644 --- a/includes/MediaWiki.php +++ b/includes/MediaWiki.php @@ -558,7 +558,7 @@ class MediaWiki { // to fail due to post data being lost, but let's try anyway // and just log the instance. // - // @todo @fixme See if we could issue a 307 or 308 here, need + // @todo FIXME: See if we could issue a 307 or 308 here, need // to see how clients (automated & browser) behave when we do wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" ); } diff --git a/includes/cache/LocalisationCache.php b/includes/cache/LocalisationCache.php index 9dc3dc3a8e..91fb878c48 100644 --- a/includes/cache/LocalisationCache.php +++ b/includes/cache/LocalisationCache.php @@ -1186,7 +1186,7 @@ class LCStoreDB implements LCStore { // We must keep a separate connection to MySQL in order to avoid breaking // main transactions. However, SQLite deadlocks when using two connections. - // @TODO: get this trick to work on PostgreSQL too + // @todo get this trick to work on PostgreSQL too if ( wfGetDB( DB_MASTER )->getType() == 'mysql' ) { $lb = wfGetLBFactory()->newMainLB(); $this->dbw = $lb->getConnection( DB_MASTER ); diff --git a/includes/content/ContentHandler.php b/includes/content/ContentHandler.php index e077c77a84..1343858c96 100644 --- a/includes/content/ContentHandler.php +++ b/includes/content/ContentHandler.php @@ -837,7 +837,7 @@ abstract class ContentHandler { * @return mixed String containing deletion reason or empty string, or * boolean false if no revision occurred * - * @XXX &$hasHistory is extremely ugly, it's here because + * @todo &$hasHistory is extremely ugly, it's here because * WikiPage::getAutoDeleteReason() and Article::generateReason() * have it / want it. */ diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php index 3aad38950a..61eb76056c 100644 --- a/includes/diff/DifferenceEngine.php +++ b/includes/diff/DifferenceEngine.php @@ -972,7 +972,7 @@ class DifferenceEngine extends ContextSource { } // Sanity: don't show the notice if too many rows must be scanned - // @TODO: show some special message for that case + // @todo show some special message for that case $nEdits = $this->mNewPage->countRevisionsBetween( $oldRev, $newRev, 1000 ); if ( $nEdits > 0 && $nEdits <= 1000 ) { $limit = 100; // use diff-multi-manyusers if too many users diff --git a/includes/filebackend/FileBackendStore.php b/includes/filebackend/FileBackendStore.php index a1ff1f4a4f..631d9498fb 100644 --- a/includes/filebackend/FileBackendStore.php +++ b/includes/filebackend/FileBackendStore.php @@ -69,7 +69,7 @@ abstract class FileBackendStore extends FileBackend { $this->mimeCallback = isset( $config['mimeCallback'] ) ? $config['mimeCallback'] : function ( $storagePath, $content, $fsPath ) { - // @TODO: handle the case of extension-less files using the contents + // @todo handle the case of extension-less files using the contents return StreamFile::contentTypeFromPath( $storagePath ) ?: 'unknown/unknown'; }; $this->memCache = new EmptyBagOStuff(); // disabled by default diff --git a/includes/filebackend/lockmanager/DBLockManager.php b/includes/filebackend/lockmanager/DBLockManager.php index b58e901600..450ccc8245 100644 --- a/includes/filebackend/lockmanager/DBLockManager.php +++ b/includes/filebackend/lockmanager/DBLockManager.php @@ -108,7 +108,7 @@ abstract class DBLockManager extends QuorumLockManager { $this->session = wfRandomString( 31 ); } - // @TODO: change this code to work in one batch + // @todo change this code to work in one batch protected function getLocksOnServer( $lockSrv, array $pathsByType ) { $status = Status::newGood(); foreach ( $pathsByType as $type => $paths ) { diff --git a/includes/objectcache/SqlBagOStuff.php b/includes/objectcache/SqlBagOStuff.php index 0c91dab43b..7328b74fef 100644 --- a/includes/objectcache/SqlBagOStuff.php +++ b/includes/objectcache/SqlBagOStuff.php @@ -145,7 +145,7 @@ class SqlBagOStuff extends BagOStuff { } else { // We must keep a separate connection to MySQL in order to avoid deadlocks // However, SQLite has an opposite behavior. - // @TODO: get this trick to work on PostgreSQL too + // @todo get this trick to work on PostgreSQL too if ( wfGetDB( DB_MASTER )->getType() == 'mysql' ) { $lb = wfGetLBFactory()->newMainLB(); $db = $lb->getConnection( DB_MASTER ); diff --git a/includes/profiler/Profiler.php b/includes/profiler/Profiler.php index 779f8b628b..cd1e8595d2 100644 --- a/includes/profiler/Profiler.php +++ b/includes/profiler/Profiler.php @@ -397,7 +397,7 @@ class TransactionProfiler { public function recordFunctionCompletion( $method, $realtime ) { if ( !$this->mDBTrxHoldingLocks ) { return; // short-circuit - // @TODO: hardcoded check is a tad janky (what about FOR UPDATE?) + // @todo hardcoded check is a tad janky (what about FOR UPDATE?) } elseif ( !preg_match( '/^query-m: (?!SELECT)/', $method ) && $realtime < $this->mDBLockThreshold ) { diff --git a/includes/specials/SpecialChangePassword.php b/includes/specials/SpecialChangePassword.php index dcd2443656..ba5c7ec3e3 100644 --- a/includes/specials/SpecialChangePassword.php +++ b/includes/specials/SpecialChangePassword.php @@ -260,7 +260,7 @@ class SpecialChangePassword extends FormSpecialPage { ); } - // @TODO Make these separate messages, since the message is written for both cases + // @todo Make these separate messages, since the message is written for both cases if ( !$user->checkTemporaryPassword( $oldpass ) && !$user->checkPassword( $oldpass ) ) { wfRunHooks( 'PrefsPasswordAudit', array( $user, $newpass, 'wrongpassword' ) ); throw new PasswordError( $this->msg( 'resetpass-wrong-oldpass' )->text() ); diff --git a/includes/specials/SpecialListusers.php b/includes/specials/SpecialListusers.php index cf11881829..53dddc70a2 100644 --- a/includes/specials/SpecialListusers.php +++ b/includes/specials/SpecialListusers.php @@ -193,7 +193,7 @@ class UsersPager extends AlphabeticPager { $edits = ''; global $wgEdititis; if ( !$this->including && $wgEdititis ) { - // @fixme i18n issue: Hardcoded square brackets. + // @todo fixme i18n issue: Hardcoded square brackets. $edits = ' [' . $this->msg( 'usereditcount' )->numParams( $row->edits )->escaped() . ']'; diff --git a/includes/specials/SpecialMergeHistory.php b/includes/specials/SpecialMergeHistory.php index 510055a803..9347af7878 100644 --- a/includes/specials/SpecialMergeHistory.php +++ b/includes/specials/SpecialMergeHistory.php @@ -477,7 +477,7 @@ class SpecialMergeHistory extends SpecialPage { array( $destTitle->getPrefixedText(), $timestampLimit ), $this->getUser() ); - # @TODO: message should use redirect=no + # @todo message should use redirect=no $this->getOutput()->addWikiMsg( 'mergehistory-success', $targetTitle->getPrefixedText(), $destTitle->getPrefixedText(), $count ); diff --git a/languages/Language.php b/languages/Language.php index 887490bcea..88d0f23eba 100644 --- a/languages/Language.php +++ b/languages/Language.php @@ -2396,7 +2396,7 @@ class Language { // Timestamps are in different years: use full timestamp // Also do full timestamp for future dates /** - * @FIXME Add better handling of future timestamps. + * @todo FIXME: Add better handling of future timestamps. */ $format = $this->getDateFormatString( 'both', $user->getDatePreference() ?: 'default' ); $ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ); diff --git a/maintenance/eraseArchivedFile.php b/maintenance/eraseArchivedFile.php index 1c3f0376d6..94ca604de9 100644 --- a/maintenance/eraseArchivedFile.php +++ b/maintenance/eraseArchivedFile.php @@ -27,7 +27,7 @@ require_once __DIR__ . '/Maintenance.php'; /** * Maintenance script to delete archived (non-current) files from storage. * - * @TODO: Maybe add some simple logging + * @todo Maybe add some simple logging * * @ingroup Maintenance * @since 1.22 diff --git a/maintenance/purgeChangedPages.php b/maintenance/purgeChangedPages.php index f0b6ec7ab7..4ce9474ffd 100644 --- a/maintenance/purgeChangedPages.php +++ b/maintenance/purgeChangedPages.php @@ -160,7 +160,7 @@ class PurgeChangedPages extends Maintenance { * If this returns an empty array for a non-empty query result, then all the rows * had the same column value and the query should be repeated with a higher LIMIT. * - * @TODO: move this elsewhere + * @todo move this elsewhere * * @param ResultWrapper $res Query result sorted by $column (ascending) * @param string $column diff --git a/tests/phpunit/includes/GlobalFunctions/GlobalTest.php b/tests/phpunit/includes/GlobalFunctions/GlobalTest.php index fd06441fe8..84799ff23e 100644 --- a/tests/phpunit/includes/GlobalFunctions/GlobalTest.php +++ b/tests/phpunit/includes/GlobalFunctions/GlobalTest.php @@ -721,5 +721,5 @@ class GlobalTest extends MediaWikiTestCase { ), ); } - /* @TODO many more! */ + /* @todo many more! */ } diff --git a/tests/phpunit/includes/MWNamespaceTest.php b/tests/phpunit/includes/MWNamespaceTest.php index 350e83fd27..311350b586 100644 --- a/tests/phpunit/includes/MWNamespaceTest.php +++ b/tests/phpunit/includes/MWNamespaceTest.php @@ -9,7 +9,7 @@ * Test class for MWNamespace. * Generated by PHPUnit on 2011-02-20 at 21:01:55. * @todo covers tags - * @FIXME this test file is a mess + * @todo FIXME: this test file is a mess * */ class MWNamespaceTest extends MediaWikiTestCase { diff --git a/tests/phpunit/includes/SanitizerValidateEmailTest.php b/tests/phpunit/includes/SanitizerValidateEmailTest.php index f13e838288..14911f0473 100644 --- a/tests/phpunit/includes/SanitizerValidateEmailTest.php +++ b/tests/phpunit/includes/SanitizerValidateEmailTest.php @@ -2,7 +2,7 @@ /** * @covers Sanitizer::validateEmail - * @TODO all test methods in this class should be refactored and... + * @todo all test methods in this class should be refactored and... * use a single test method and a single data provider... */ class SanitizerValidateEmailTest extends MediaWikiTestCase {