summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--includes/form.inc2
1 files changed, 2 insertions, 0 deletions
diff --git a/includes/form.inc b/includes/form.inc
index a337b03d1..b024918a3 100644
--- a/includes/form.inc
+++ b/includes/form.inc
@@ -4074,6 +4074,8 @@ function _form_set_class(&$element, $class = array()) {
* Sample 'finished' callback:
* @code
* function batch_test_finished($success, $results, $operations) {
+ * // The 'success' parameter means no fatal PHP errors were detected. All
+ * // other error management should be handled using 'results'.
* if ($success) {
* $message = format_plural(count($results), 'One post processed.', '@count posts processed.');
* }