From c0ad2ad7bb7812cee8220639c906626e85ce7f1f Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Tue, 24 Nov 2015 14:48:56 -0800 Subject: [PATCH] Add comments to EditPage::getBaseRevision() Change-Id: Ib0b9e26916f86f00a49c6007ae55896f7421de22 --- includes/EditPage.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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 ) { -- 2.20.1