From 70c1b8e15ac087a10525adc35d13c19a72927d31 Mon Sep 17 00:00:00 2001 From: Pouria Hadjibagheri Date: Sun, 12 Mar 2017 20:57:18 +0000 Subject: [PATCH] Now with comprehensive documentations. --- markdownx/models.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/markdownx/models.py b/markdownx/models.py index a1a6169..497f423 100644 --- a/markdownx/models.py +++ b/markdownx/models.py @@ -11,8 +11,8 @@ class MarkdownxField(models.TextField): fields. For consistency therefore, the descriptions have been borrowed from Django's official documentations (with minor modifications). - :param verbose_name: A human-readable name for the field. If the verbose name isn’t given, - Django will automatically create it using the field’s attribute name, + :param verbose_name: A human-readable name for the field. If the verbose name isn't given, + Django will automatically create it using the field's attribute name, converting underscores to spaces. :type verbose_name: str :param blank: If ``True``, the field is allowed to be blank. Default is ``False``. @@ -23,8 +23,8 @@ class MarkdownxField(models.TextField): :param editable: If ``False``, the field will not be displayed in the admin or any other ModelForm. They are also skipped during model validation. Default is ``True``. :type editable: bool - :param help_text: Extra “help” text to be displayed with the form widget. It’s useful for - documentation even if your field isn’t used on a form. Note that this value + :param help_text: Extra “help” text to be displayed with the form widget. It's useful for + documentation even if your field isn't used on a form. Note that this value is not HTML-escaped in automatically-generated forms. This lets you include HTML in ``help_text`` if you so desire. :type help_text: str