jenkins-bot has submitted this change and it was merged.
Change subject: More accurate function descriptions
......................................................................
More accurate function descriptions
Change-Id: I633a7740996b8933778aa32036cb429026f75ebe
---
M includes/User.php
1 file changed, 11 insertions(+), 4 deletions(-)
Approvals:
Kaldari: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/User.php b/includes/User.php
index 685bce7..973e7cc 100644
--- a/includes/User.php
+++ b/includes/User.php
@@ -1828,8 +1828,14 @@
}
/**
- * Return the revision and link for the oldest new talk page message for
- * this user.
+ * Return the data needed to construct links for new talk page message
+ * alerts. If there are new messages, this will return an associative
array
+ * with the following data:
+ * wiki: The database name of the wiki
+ * link: Root-relative link to the user's talk page
+ * rev: The last talk page revision that the user has seen or null.
This
+ * is useful for building diff links.
+ * If there are no new messages, it returns an empty array.
* @note This function was designed to accomodate multiple talk pages,
but
* currently only returns a single link and revision.
* @return Array
@@ -1853,8 +1859,9 @@
}
/**
- * Get the revision ID for the oldest new talk page message for this
user
- * @return int|null Revision id or null if there are no new messages
+ * Get the revision ID for the last talk page revision viewed by the
talk
+ * page owner.
+ * @return int|null Revision ID or null
*/
public function getNewMessageRevisionId() {
$newMessageRevisionId = null;
--
To view, visit https://gerrit.wikimedia.org/r/74575
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I633a7740996b8933778aa32036cb429026f75ebe
Gerrit-PatchSet: 4
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Kaldari <[email protected]>
Gerrit-Reviewer: Bsitu <[email protected]>
Gerrit-Reviewer: Kaldari <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits