mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-13 10:50:55 +00:00
Code Issues 32 Releases Wiki Activity

[1.6.x] Fixed #14006 -- Documented that Field's 'description' attribute is interpolated with field.__dict__

Browse Source 
Thanks abeld for the suggestion.

Backport of 2d96e660f9 from master.
This commit is contained in:
Tim Graham 2013-07-06 18:31:59 -04:00
parent a9dd6221af
commit a22b2aea19
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/howto/custom-model-fields.txt
View File

@ -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`` the above example, the description displayed by the ``admindocs``
application for a ``HandField`` will be 'A hand of cards (bridge style)'. 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 Useful methods
-------------- --------------