Browse Source

Fixed #23558 -- documented slugify limitations

David Hoffman 10 years ago
parent
commit
03467368db
4 changed files with 12 additions and 12 deletions
  1. 3 3
      django/template/defaultfilters.py
  2. 3 3
      django/utils/text.py
  3. 3 3
      docs/ref/templates/builtins.txt
  4. 3 3
      docs/ref/utils.txt

+ 3 - 3
django/template/defaultfilters.py

@@ -228,9 +228,9 @@ def make_list(value):
 @stringfilter
 def slugify(value):
     """
-    Converts to lowercase, removes non-word characters (alphanumerics and
-    underscores) and converts spaces to hyphens. Also strips leading and
-    trailing whitespace.
+    Converts to ASCII. Converts spaces to hyphens. Removes characters that
+    aren't alphanumerics, underscores, or hyphens. Converts to lowercase.
+    Also strips leading and trailing whitespace.
     """
     return _slugify(value)
 

+ 3 - 3
django/utils/text.py

@@ -438,9 +438,9 @@ unescape_string_literal = allow_lazy(unescape_string_literal)
 
 def slugify(value):
     """
-    Converts to lowercase, removes non-word characters (alphanumerics and
-    underscores) and converts spaces to hyphens. Also strips leading and
-    trailing whitespace.
+    Converts to ASCII. Converts spaces to hyphens. Removes characters that
+    aren't alphanumerics, underscores, or hyphens. Converts to lowercase.
+    Also strips leading and trailing whitespace.
     """
     value = force_text(value)
     value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore').decode('ascii')

+ 3 - 3
docs/ref/templates/builtins.txt

@@ -2024,9 +2024,9 @@ If ``some_list`` is ``['a', 'b', 'c']``, the output will be ``['a', 'b']``.
 slugify
 ^^^^^^^
 
-Converts to lowercase, removes non-word characters (alphanumerics and
-underscores) and converts spaces to hyphens. Also strips leading and trailing
-whitespace.
+Converts to ASCII. Converts spaces to hyphens. Removes characters that aren't
+alphanumerics, underscores, or hyphens. Converts to lowercase. Also strips
+leading and trailing whitespace.
 
 For example::
 

+ 3 - 3
docs/ref/utils.txt

@@ -842,9 +842,9 @@ appropriate entities.
 
 .. function:: slugify
 
-    Converts to lowercase, removes non-word characters (alphanumerics and
-    underscores) and converts spaces to hyphens. Also strips leading and
-    trailing whitespace.
+    Converts to ASCII. Converts spaces to hyphens. Removes characters that
+    aren't alphanumerics, underscores, or hyphens. Converts to lowercase. Also
+    strips leading and trailing whitespace.
 
     For example::