Changeset 1570

Timestamp:

12/08/05 19:53:30 (3 years ago)

Author:

adrian

Message:

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

Files:

• django/trunk/docs/model-api.txt (modified) (1 diff)

django/trunk/docs/model-api.txt

@@ -104 +104 @@
-    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``