From 96604fdf8f34a9e51d1f61a8c81ba5ef843b5ee9 Mon Sep 17 00:00:00 2001 From: Jacob Kaplan-Moss Date: Mon, 26 Feb 2007 21:40:15 +0000 Subject: [PATCH] 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 --- docs/model-api.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/model-api.txt b/docs/model-api.txt index 9f87d53719..51f4b72c22 100644 --- a/docs/model-api.txt +++ b/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