Clarify field_purge_batch documentation [#1395974]

field_purge_batch(10);

which confused me wondering why it only deletes 10 forums. So I went on IRC and webchick says that means it deletes 10 at a time. But the top of field_purge_batch says:

This function will purge deleted field data on up to a specified maximum number of entities and then return.

which sounds like it only deletes the number of items sent in to it and that's it. Seems like that should be re-worded to explain that it deletes X at a time until they are all gone rather than just deleting X total.

Michelle

Comment	File	Size	Author
#2	drupal-api-1395974-2.patch	1.19 KB	webbykat

Comments

Comment #1

webbykat commented 23 March 2012 at 17:07

Agreed - a small wording change would make this clearer for newbies. The current line at the field_purge_batch documentation is "This function will purge deleted field data on up to a specified maximum number of entities and then return." I suggest changing to "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 until all have completed."

Comment #2

webbykat commented 23 March 2012 at 17:52

Status:

Active

» Needs review

Status	File	Size
new	drupal-api-1395974-2.patch	1.19 KB

Patch with wording change attached. Final text:

* 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.