Add comments to EditPage::getBaseRevision()

Change-Id: Ib0b9e26916f86f00a49c6007ae55896f7421de22

diff --git a/includes/EditPage.php b/includes/EditPage.php
index 8f33a9f..023c170 100644 (file)
--- 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 ) {