From: Umherirrender <umherirrender_de.wp@web.de>
Date: Fri, 7 Jun 2019 17:22:19 +0000 (+0200)
Subject: Fix documentation of Maintenance::updateSearchIndex
X-Git-Tag: 1.34.0-rc.0~1472^2
X-Git-Url: http://git.heureux-cyclage.org/?a=commitdiff_plain;h=9d82a218ac3812da2adbb68600fd488970b79f90;hp=44b524827e3004d4f2fbcb19c194c702c651d1f2;p=lhc%2Fweb%2Fwiklou.git

Fix documentation of Maintenance::updateSearchIndex

Document callback as callable type and the results part as
IResultWrapper to match the implementation, which is passing return of
Database::query to this function

Change-Id: I63ee8d4907590a21ef34d0b761b8fabfe0ff2569
---

diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php
index 44ce9a5d18..160b1135f6 100644
--- a/maintenance/Maintenance.php
+++ b/maintenance/Maintenance.php
@@ -26,6 +26,7 @@ require_once __DIR__ . '/../includes/PHPVersionCheck.php';
 wfEntryPointCheck( 'text' );
 
 use MediaWiki\Shell\Shell;
+use Wikimedia\Rdbms\IResultWrapper;
 
 /**
  * @defgroup MaintenanceArchive Maintenance archives
@@ -1478,9 +1479,9 @@ abstract class Maintenance {
 	/**
 	 * Perform a search index update with locking
 	 * @param int $maxLockTime The maximum time to keep the search index locked.
-	 * @param string $callback The function that will update the function.
+	 * @param callable $callback The function that will update the function.
 	 * @param IMaintainableDatabase $dbw
-	 * @param array $results
+	 * @param array|IResultWrapper $results
 	 */
 	public function updateSearchIndex( $maxLockTime, $callback, $dbw, $results ) {
 		$lockTime = time();