summaryrefslogtreecommitdiff
path: root/django/utils/text.py
diff options
context:
space:
mode:
authorRussell Keith-Magee <russell@keith-magee.com>2010-08-07 14:57:24 +0000
committerRussell Keith-Magee <russell@keith-magee.com>2010-08-07 14:57:24 +0000
commit806f3b26f80c729dede7f10b463691d1f5aae13e (patch)
tree76e095303dc8161585f0c24ede2c72232d917872 /django/utils/text.py
parent103f7f83eb5f46bcfa2473dadc38a19f59832565 (diff)
Fixed #11021 -- Clarified newline stripping behavior in the truncatewords and truncatewords_html filters. Thanks to Ben Spaulding for the report and patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13555 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'django/utils/text.py')
-rw-r--r--django/utils/text.py12
1 files changed, 9 insertions, 3 deletions
diff --git a/django/utils/text.py b/django/utils/text.py
index 5d633b7afe..b05460486d 100644
--- a/django/utils/text.py
+++ b/django/utils/text.py
@@ -39,7 +39,10 @@ wrap = allow_lazy(wrap, unicode)
def truncate_words(s, num, end_text='...'):
"""Truncates a string after a certain number of words. Takes an optional
argument of what should be used to notify that the string has been
- truncated, defaults to ellipsis (...)"""
+ truncated, defaulting to ellipsis (...)
+
+ Newlines in the string will be stripped.
+ """
s = force_unicode(s)
length = int(num)
words = s.split()
@@ -51,10 +54,13 @@ def truncate_words(s, num, end_text='...'):
truncate_words = allow_lazy(truncate_words, unicode)
def truncate_html_words(s, num, end_text='...'):
- """Truncates html to a certain number of words (not counting tags and
+ """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. Takes an optional argument of what should be used to notify that the
- string has been truncated, defaults to ellipsis (...)."""
+ string has been truncated, defaulting to ellipsis (...).
+
+ Newlines in the HTML are preserved.
+ """
s = force_unicode(s)
length = int(num)
if length <= 0: