minor #6297 clarify the signature of the choice_value callable (backbone87)

weaverryan · weaverryan · commit 3a478a22e51d · 2017-09-27T15:53:50.000-04:00
This PR was squashed before being merged into the 2.7 branch (closes #6297). Discussion ---------- clarify the signature of the choice_value callable | Q | A | | --- | --- | | Doc fix? | yes | | New docs? | no | | Applies to | 2.7+ | | Fixed tickets | | Commits ------- 5cf83f6 clarify the signature of the choice_value callable
diff --git a/reference/forms/types/options/choice_value.rst.inc b/reference/forms/types/options/choice_value.rst.inc
@@ -11,8 +11,14 @@ in HTML and submitted in the POST/PUT requests. You don't normally need to worry
 about this, but it might be handy when processing an API request (since you can
 configure the value that will be sent in the API request).
 
-This can be a callable or a property path. See `choice_label`_ for similar usage.
-If ``null`` is used, an incrementing integer is used as the name.
+This can be a callable or a property path. If ``null`` is given, an incrementing
+integer is used as the value.
+
+.. note::
+
+    In contrast to other choice options (e.g. `choice_label`_), the callable for
+    the ``choice_value`` option takes as **only** argument the actual choice, which
+    is also the value that gets passed to your model when submitting the form.
 
 If you are using a callable to populate ``choice_value``, you need to check
 for the case that the value of the field may be ``null``.
