Make sure docs encourage __METHOD__ use for begin/commit
authorAaron Schulz <aschulz@wikimedia.org>
Thu, 24 Dec 2015 01:23:15 +0000 (17:23 -0800)
committerAaron Schulz <aschulz@wikimedia.org>
Thu, 24 Dec 2015 01:23:15 +0000 (17:23 -0800)
Change-Id: Id9c2d1b30f9dd758b418894b5751556daff20f0e

includes/libs/objectcache/WANObjectCache.php

index 01f8ccc..4aa868e 100644 (file)
@@ -450,7 +450,7 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
         *
         * Example usage:
         * @code
-        *     $dbw->begin(); // start of request
+        *     $dbw->begin( __METHOD__ ); // start of request
         *     ... <execute some stuff> ...
         *     // Update the row in the DB
         *     $dbw->update( ... );
@@ -460,7 +460,7 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
         *         $cache->delete( $key );
         *     } );
         *     ... <execute some stuff> ...
-        *     $dbw->commit(); // end of request
+        *     $dbw->commit( __METHOD__ ); // end of request
         * @endcode
         *
         * The $ttl parameter can be used when purging values that have not actually changed