From 80673e20f212fbefd1a8d53ae521e95c6eedf201 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Sat, 6 Jul 2013 18:31:59 -0400 Subject: [PATCH] [1.5.x] Fixed #14006 -- Documented that Field's 'description' attribute is interpolated with field.__dict__ Thanks abeld for the suggestion. Backport of 2d96e660f9 from master. --- docs/howto/custom-model-fields.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/howto/custom-model-fields.txt b/docs/howto/custom-model-fields.txt index 54f2da7a1d..e87d4f78b3 100644 --- a/docs/howto/custom-model-fields.txt +++ b/docs/howto/custom-model-fields.txt @@ -314,6 +314,13 @@ descriptive text in a ``description`` class attribute of your custom field. In the above example, the description displayed by the ``admindocs`` application for a ``HandField`` will be 'A hand of cards (bridge style)'. +In the :mod:`django.contrib.admindocs` display, the field description is +interpolated with ``field.__dict__`` which allows the description to +incorporate arguments of the field. For example, the description for +:class:`~django.db.models.CharField` is:: + + description = _("String (up to %(max_length)s)") + Useful methods --------------