From ab9103bca255ccd5263edee3d751b24dd24e86c6 Mon Sep 17 00:00:00 2001
From: webchick <webchick@24967.no-reply.drupal.org>
Date: Wed, 1 Jun 2011 01:39:51 -0700
Subject: [PATCH] Issue #604902 by rschwab, drewish: Add documentation about
Batch API success parameter.
---
includes/form.inc | 2 ++
1 file changed, 2 insertions(+)
diff --git a/includes/form.inc b/includes/form.inc
index c0e2ec7c1556..8f2ee2632eaa 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.');
* }
--
GitLab