Context Navigation

Ticket #11021: truncate-doc.diff

File truncate-doc.diff, 2.3 KB (added by Ben Spaulding, 15 years ago)
Documentation of truncatewords behavior re newlines.

diff --git a/django/template/defaultfilters.py b/django/template/defaultfilters.py
index 47e116c..531e6ab 100644

                def truncatewords(value, arg):
     Truncates a string after a certain number of words.
     Argument: Number of words to truncate after.
+    Note that newlines within the string are removed.
     """
     from django.utils.text import truncate_words
     try:
-…
+               def truncatewords_html(value, arg):
     Truncates HTML after a certain number of words.
     Argument: Number of words to truncate after.
+    Note that newlines are preserved, unlike `truncatewords`.
     """
     from django.utils.text import truncate_html_words
     try:

diff --git a/django/utils/text.py b/django/utils/text.py
index fe46e26..0e03bd5 100644

                def wrap(text, width):
 wrap = allow_lazy(wrap, unicode)
 def truncate_words(s, num):
+    "Truncates a string after a certain number of words."
+    """
+    Truncates a string after a certain number of words.
+    Note that newlines within the string are removed.
+    """
     s = force_unicode(s)
     length = int(num)
     words = s.split()
-…
+               def truncate_html_words(s, num):
     Truncates html to a certain number of words (not counting tags and
     comments). Closes opened tags if they were correctly closed in the given
     html.
+    Note that newlines are preserved, unlike `truncate_words`.
     """
     s = force_unicode(s)
     length = int(num)

diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt
index f4e49a9..4dd5416 100644

                For example::
 If ``value`` is ``"Joel is a slug"``, the output will be ``"Joel is ..."``.
+Note that newlines within the string are removed.
 .. templatefilter:: truncatewords_html
 truncatewords_html
-…
+               closed immediately after the truncation.
 This is less efficient than ``truncatewords``, so should only be used when it
 is being passed HTML text.
+Note that newlines are preserved, unlike the `truncatewords`_ filter.
 .. templatefilter:: unordered_list
 unordered_list