summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwebchick2012-03-23 19:45:06 (GMT)
committerwebchick2012-03-23 19:45:06 (GMT)
commit0eda2c587055cca8089f933d75aa9a4ad74b5247 (patch)
tree3a010c96bab1707592fb5f12862c600c2647fab4
parent824ba69df54fb2e50c7e71c28a3a6f90920cce31 (diff)
Issue #1395974 by webbykat, Michelle, rdrh555: Clarify field_purge_batch() documentation.
-rw-r--r--core/modules/field/field.crud.inc11
1 files changed, 6 insertions, 5 deletions
diff --git a/core/modules/field/field.crud.inc b/core/modules/field/field.crud.inc
index 6df3235..f9c96c9 100644
--- a/core/modules/field/field.crud.inc
+++ b/core/modules/field/field.crud.inc
@@ -835,11 +835,12 @@ function field_delete_instance($instance, $field_cleanup = TRUE) {
/**
* Purges a batch of deleted Field API data, instances, or fields.
*
- * This function will purge deleted field data on up to a specified maximum
- * number of entities and then return. If a deleted field instance with no
- * remaining data records is found, the instance itself will be purged.
- * If a deleted field with no remaining field instances is found, the field
- * itself will be purged.
+ * This function will purge deleted field data in batches. The batch size
+ * is defined as an argument to the function, and once each batch is finished,
+ * it continues with the next batch until all have completed. If a deleted field
+ * instance with no remaining data records is found, the instance itself will
+ * be purged. If a deleted field with no remaining field instances is found, the
+ * field itself will be purged.
*
* @param $batch_size
* The maximum number of field data records to purge before returning.