From: daniel <dkinzler@wikimedia.org>
Date: Tue, 24 Sep 2019 17:18:08 +0000 (+0200)
Subject: Improve documentation of newRevisionsFromBatch()
X-Git-Tag: 1.34.0-rc.0~88^2~1
X-Git-Url: https://git.cyclocoop.org/%27%20.%20%24this-%3EgetSkin%28%29-%3EescapeSearchLink%28%29%20.%20%27?a=commitdiff_plain;h=ffde7b8cb46a25b16ca28cd39665489d83102456;p=lhc%2Fweb%2Fwiklou.git

Improve documentation of newRevisionsFromBatch()

Document purpose and behavior of the $title parameter.

Bug: T228988
Change-Id: I89966321ec3b4feb5a59e06b8a656d76c4bd9ef2
---

diff --git a/includes/Revision/RevisionStore.php b/includes/Revision/RevisionStore.php
index 3ecef76fa0..a5cf8404cb 100644
--- a/includes/Revision/RevisionStore.php
+++ b/includes/Revision/RevisionStore.php
@@ -1907,7 +1907,11 @@ class RevisionStore
 	 *               'content'- whether the actual content of the slots should be
 	 *               preloaded.
 	 * @param int $queryFlags
-	 * @param Title|null $title
+	 * @param Title|null $title The title to which all the revision rows belong, if there
+	 *        is such a title and the caller has it handy, so we don't have to look it up again.
+	 *        If this parameter is given and any of the rows has a rev_page_id that is different
+	 *        from $title->getArticleID(), an InvalidArgumentException is thrown.
+	 *
 	 * @return StatusValue a status with a RevisionRecord[] of successfully fetched revisions
 	 * 					   and an array of errors for the revisions failed to fetch.
 	 */