Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed #3455: added documentation of Model.get_FIELD_display(). Thanks…

…, Ubernostrum.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@4625 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 96604fdf8f34a9e51d1f61a8c81ba5ef843b5ee9 1 parent 9f1bf46
@jacobian jacobian authored
Showing with 7 additions and 0 deletions.
  1. +7 −0 docs/model-api.txt
View
7 docs/model-api.txt
@@ -498,6 +498,13 @@ or outside your model class altogether::
class Foo(models.Model):
gender = models.CharField(maxlength=1, choices=GENDER_CHOICES)
+For each field on your model which has ``choices`` set, Django will
+add a method to retrieve the human-readable name for the field's
+current value; see `get_FOO_display`_ in the database API
+documentation.
+
+.. _get_FOO_display: ../db_api/#get-foo-display
+
Finally, note that choices can be any iterable object -- not necessarily a
list or tuple. This lets you construct choices dynamically. But if you find
yourself hacking ``choices`` to be dynamic, you're probably better off using
Please sign in to comment.
Something went wrong with that request. Please try again.