Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[1.1.X] Fixed #12601: Documented the slug field in the forms module. …

…Backport of [12673] from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.1.X@12674 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 1332b114cc465cc34f2d9ab1b6dc15837b49415d 1 parent 36e7739
James Bennett authored March 03, 2010

Showing 1 changed file with 15 additions and 0 deletions. Show diff stats Hide diff stats

  1. 15  docs/ref/forms/fields.txt
15  docs/ref/forms/fields.txt
@@ -643,6 +643,21 @@ compatibility. The preferred way to provide an error message is to use the
643 643
 ``error_messages`` argument, passing a dictionary with ``'invalid'`` as a key
644 644
 and the error message as the value.
645 645
 
  646
+``SlugField``
  647
+~~~~~~~~~~~~~
  648
+
  649
+.. class:: SlugField(**kwargs)
  650
+
  651
+   * Default widget: ``TextInput``
  652
+   * Empty value: ``''`` (an empty string)
  653
+   * Normalizes to: A Unicode object.
  654
+   * Validates that the given value contains only letters, numbers and
  655
+     hyphens.
  656
+   * Error messages: ``required``, ``invalid``
  657
+
  658
+This field is intended for use in representing a model
  659
+:class:`~django.db.models.SlugField` in forms.
  660
+
646 661
 ``TimeField``
647 662
 ~~~~~~~~~~~~~
648 663
 

0 notes on commit 1332b11

Please sign in to comment.
Something went wrong with that request. Please try again.