From: Aaron Schulz <aschulz@wikimedia.org>
Date: Fri, 25 Jan 2013 19:50:02 +0000 (-0800)
Subject: Improved BagOStuff docs.
X-Git-Tag: 1.31.0-rc.0~20915
X-Git-Url: https://git.cyclocoop.org/%7B%24admin_url%7Dmembres/modifier.php?a=commitdiff_plain;h=e2e6b161239ece68d1f95a0d548c0498b324b8ba;p=lhc%2Fweb%2Fwiklou.git

Improved BagOStuff docs.

Change-Id: I01c62de23b73e1bac96aede73cd6995df8ff1221
---

diff --git a/includes/objectcache/BagOStuff.php b/includes/objectcache/BagOStuff.php
index 03b0d5b920..1205ceb842 100644
--- a/includes/objectcache/BagOStuff.php
+++ b/includes/objectcache/BagOStuff.php
@@ -89,7 +89,9 @@ abstract class BagOStuff {
 	abstract public function delete( $key, $time = 0 );
 
 	/**
-	 * Merge changes into the existing cache value (possibly creating a new one)
+	 * Merge changes into the existing cache value (possibly creating a new one).
+	 * The callback function returns the new value given the current value (possibly false),
+	 * and takes the arguments: (this BagOStuff object, cache key, current value).
 	 *
 	 * @param $key string
 	 * @param $callback closure Callback method to be executed