Merge "Display a return to Special:Watchlist instead of main page in Special:EditWatc...

[lhc/web/wiklou.git] / includes / DataUpdate.php

diff --git a/includes/DataUpdate.php b/includes/DataUpdate.php
index 7203c3b..793d335 100644 (file)
--- a/includes/DataUpdate.php
+++ b/includes/DataUpdate.php
@@ -24,6 +24,10 @@
 /**
  * Abstract base class for update jobs that do something with some secondary
  * data extracted from article.
+ *
+ * @note: subclasses should NOT start or commit transactions in their doUpdate() method,
+ *        a transaction will automatically be wrapped around the update. If need be,
+ *        subclasses can override the beginTransaction() and commitTransaction() methods.
  */
 abstract class DataUpdate implements DeferrableUpdate {