Fixed #972 -- Improved docs for 'choices' model field option. Thanks, radek

git-svn-id: http://code.djangoproject.com/svn/django/trunk@1570 bcc190cf-cafb-0310-a4f2-bffc1f526a37

1 files changed, 19 insertions, 0 deletions

diff --git a/docs/model-api.txt b/docs/model-api.txt
index 3245b2a78a..a6e5adf917 100644
--- a/docs/model-api.txt
+++ b/docs/model-api.txt
@@ -104,6 +104,25 @@ The following arguments are available to all field types. All are optional.
     The first element in each tuple is the actual value to be stored. The
     second element is the human-readable name for the option.
 
+    Define the choices list **outside** of your model class, not inside it.
+    For example, this is not valid::
+
+        class Foo(meta.Model):
+            GENDER_CHOICES = (
+                ('M', 'Male'),
+                ('F', 'Female'),
+            )
+            gender = meta.CharField(maxlength=1, choices=GENDER_CHOICES)
+
+    But this is valid::
+
+        GENDER_CHOICES = (
+            ('M', 'Male'),
+            ('F', 'Female'),
+        )
+        class Foo(meta.Model):
+            gender = meta.CharField(maxlength=1, choices=GENDER_CHOICES)
+
 ``core``
     For objects that are edited inline to a related object.