From e86030b3be2ac9af4a2855d88802c0b750152c8a Mon Sep 17 00:00:00 2001
From: Tim Graham <timograham@gmail.com>
Date: Wed, 27 Aug 2014 07:43:13 -0400
Subject: [PATCH] [1.7.x] Fixed #23354 -- Documented that ModelChoiceField
to_field_name should be a unique field.
Thanks Keryn Knight for the suggestion.
Backport of 83762da3fb from master
---
docs/ref/forms/fields.txt | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt
index 1eeb65261e7..0bcbe6c72cd 100644
--- a/docs/ref/forms/fields.txt
+++ b/docs/ref/forms/fields.txt
@@ -1061,8 +1061,10 @@ method::
.. attribute:: to_field_name
This optional argument is used to specify the field to use as the value
- of the choices in the field's widget. By default it is set to ``None``,
- in which case the primary key of each object will be used. For example::
+ of the choices in the field's widget. Be sure it's a unique field for
+ the model, otherwise the selected value could match more than one
+ object. By default it is set to ``None``, in which case the primary key
+ of each object will be used. For example::
# No custom to_field_name
field1 = forms.ModelChoiceField(queryset=...)