From 4682cbd505f065a8679890e2ca2daf4e67eb0f8a Mon Sep 17 00:00:00 2001
From: Mac_Weber <Mac_Weber@789986.no-reply.drupal.org>
Date: Tue, 18 Oct 2011 04:31:14 -0200
Subject: [PATCH] Issue #570314: more detailed form_set_value() documentation

---
 includes/form.inc |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/includes/form.inc b/includes/form.inc
index 8c3b14a..1ad6a45 100644
--- a/includes/form.inc
+++ b/includes/form.inc
@@ -2403,11 +2403,13 @@ function form_type_token_value($element, $input = FALSE) {
 }
 
 /**
- * Change submitted form values during form validation.
+ * Changes submitted form values (in $form_state) during form validation.
  *
  * Use this function to change the submitted value of a form element in a form
  * validation function, so that the changed value persists in $form_state
- * through to the submission handlers.
+ * through the remaining validation and submission handlers. It does not change
+ * the values that may be present in the $element array, but only in
+ * $form_state, which is where the submitted values are always stored.
  *
  * Note that form validation functions are specified in the '#validate'
  * component of the form array (the value of $form['#validate'] is an array of
-- 
1.7.7

