Merge "wl_notificationtimestamp code comments typo, false statement"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Wed, 3 Jun 2015 13:37:33 +0000 (13:37 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Wed, 3 Jun 2015 13:37:33 +0000 (13:37 +0000)
includes/mail/EmailNotification.php

index 5ed52c4..c359659 100644 (file)
@@ -61,7 +61,7 @@ class EmailNotification {
         * @param User $editor The editor that triggered the update.  Their notification
         *  timestamp will not be updated(they have already seen it)
         * @param Title $title The title to update timestamps for
-        * @param string $timestamp Set the upate timestamp to this value
+        * @param string $timestamp Set the update timestamp to this value
         * @return int[]
         */
        public static function updateWatchlistTimestamp( User $editor, Title $title, $timestamp ) {
@@ -110,7 +110,6 @@ class EmailNotification {
 
        /**
         * Send emails corresponding to the user $editor editing the page $title.
-        * Also updates wl_notificationtimestamp.
         *
         * May be deferred via the job queue.
         *
@@ -187,8 +186,8 @@ class EmailNotification {
         * Immediate version of notifyOnPageChange().
         *
         * Send emails corresponding to the user $editor editing the page $title.
-        * Also updates wl_notificationtimestamp.
         *
+        * @note Do not call directly. Use notifyOnPageChange so that wl_notificationtimestamp is updated.
         * @param User $editor
         * @param Title $title
         * @param string $timestamp Edit timestamp