Skip to content

clarify the signature of the choice_value callable #6297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

clarify the signature of the choice_value callable #6297

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
222cac4
clarify the signature of the choice_value callable
backbone87 Feb 22, 2016
b3b20df
fixup! clarify the signature of the choice_value callable
backbone87 Feb 23, 2016
fc01a70
fixup! clarify the signature of the choice_value callable
backbone87 Feb 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions reference/forms/types/options/choice_value.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, but now I'm re-reading it and I think that ", which is also the value that gets passed to your model when submitting the form" is too confusing. It better should be defined outside of this note, when clarifying the responsibility of this option to return a unique string representation of the choice.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@backbone87 Can you reword this a bit?


.. caution::

Expand Down