* Fixed indentation

* Fixed assumption about message keys that was no longer true
* Ping r97207
* Clarified the part about null

diff --git a/includes/revisiondelete/RevisionDeleter.php b/includes/revisiondelete/RevisionDeleter.php
index b6d3cb6..ff62f7e 100644 (file)
--- a/includes/revisiondelete/RevisionDeleter.php
+++ b/includes/revisiondelete/RevisionDeleter.php
@@ -29,13 +29,16 @@ class RevisionDeleter {
 
        /**
         * Gets an array of message keys describing the changes made to the
-     * visibility of the revision.
-     *
-     * If the resulting array is $arr, then $arr[0] will contain an array of
-     * message keys describing the items that were hidden, $arr[1] will contain
-        * an array of message keys describing the items that were unhidden, and $arr[2]
-     * will contain an array with a single message key, which can be one of
-     * "revdelete-restricted", "revdelete-unrestricted", or null, indicating (un)suppression.
+        * visibility of the revision.
+        *
+        * If the resulting array is $arr, then $arr[0] will contain an array of
+        * keys describing the items that were hidden, $arr[1] will contain
+        * an array of keys describing the items that were unhidden, and $arr[2]
+        * will contain an array with a single message key, which can be one of
+        * "revdelete-restricted", "revdelete-unrestricted" indicating (un)suppression
+        * or null to indicate nothing in particular.
+        * You can turn the keys in 0 and 1 into message keys by appendin -hid and
+        * and -unhid to they keys respectively.
         *
         * @param $n Integer: the new bitfield.
         * @param $o Integer: the old bitfield.