Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed #12601: Documented the slug field in the forms module.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@12673 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 926bf195e007cb4f97e6ddc4bd963cb5a8d48288 1 parent 795e323
@ubernostrum ubernostrum authored
Showing with 15 additions and 0 deletions.
  1. +15 −0 docs/ref/forms/fields.txt
View
15 docs/ref/forms/fields.txt
@@ -659,6 +659,21 @@ compatibility. The preferred way to provide an error message is to use the
``error_messages`` argument, passing a dictionary with ``'invalid'`` as a key
and the error message as the value.
+``SlugField``
+~~~~~~~~~~~~~
+
+.. class:: SlugField(**kwargs)
+
+ * Default widget: ``TextInput``
+ * Empty value: ``''`` (an empty string)
+ * Normalizes to: A Unicode object.
+ * Validates that the given value contains only letters, numbers and
+ hyphens.
+ * Error messages: ``required``, ``invalid``
+
+This field is intended for use in representing a model
+:class:`~django.db.models.SlugField` in forms.
+
``TimeField``
~~~~~~~~~~~~~
Please sign in to comment.
Something went wrong with that request. Please try again.