Issue #2182187 by izus: Clarify documentation for taxonomy_vocabulary_delete()

2014-03-12 09:59:28 -07:00 · 2014-03-12 09:59:28 -07:00 · 7c6dbceaaa
parent b7cab54c52
commit 7c6dbceaaa
1 changed files with 6 additions and 1 deletions
--- a/modules/taxonomy/taxonomy.module
+++ b/modules/taxonomy/taxonomy.module
@ -457,7 +457,12 @@ function taxonomy_vocabulary_save($vocabulary) {
 }

 /**
- * Delete a vocabulary.
+ * Deletes a vocabulary.
+ *
+ * This will update all Taxonomy fields so that they don't reference the
+ * deleted vocabulary. It also will delete fields that have no remaining
+ * vocabulary references. All taxonomy terms of the deleted vocabulary
+ * will be deleted as well.
 *
 * @param $vid
 *   A vocabulary ID.