From: Aaron Schulz <aschulz@wikimedia.org>
Date: Tue, 24 Nov 2015 22:48:56 +0000 (-0800)
Subject: Add comments to EditPage::getBaseRevision()
X-Git-Tag: 1.31.0-rc.0~8870^2
X-Git-Url: http://git.cyclocoop.org/%22.%24image2.%22?a=commitdiff_plain;h=c0ad2ad7bb7812cee8220639c906626e85ce7f1f;p=lhc%2Fweb%2Fwiklou.git

Add comments to EditPage::getBaseRevision()

Change-Id: Ib0b9e26916f86f00a49c6007ae55896f7421de22
---

diff --git a/includes/EditPage.php b/includes/EditPage.php
index 8f33a9f687..023c170e83 100644
--- a/includes/EditPage.php
+++ b/includes/EditPage.php
@@ -2147,7 +2147,9 @@ class EditPage {
 	}
 
 	/**
-	 * @return Revision
+	 * @note: this method is very poorly named. If the user opened the form with ?oldid=X,
+	 *        one might think of X as the "base revision", which is NOT what this returns.
+	 * @return Revision Current version when the edit was started
 	 */
 	function getBaseRevision() {
 		if ( !$this->mBaseRevision ) {