浏览代码

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

Thanks abeld for the suggestion.
Tim Graham 11 年之前
父节点
当前提交
2d96e660f9
共有 1 个文件被更改,包括 7 次插入0 次删除
  1. 7 0
      docs/howto/custom-model-fields.txt

+ 7 - 0
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
 --------------