diff options
author | AquarHEAD L <aquarhead@gmail.com> | 2012-11-26 04:37:13 +0800 |
---|---|---|
committer | AquarHEAD L <aquarhead@gmail.com> | 2012-11-26 04:37:13 +0800 |
commit | 8e01f54765b66c2f5e8bfa316157e5669e940229 (patch) | |
tree | 95e4984645dbfc3e3cc27923f2270ac0cc69760a /jinja2 | |
parent | 21a2010bf2768bc658e09666c2135063ce004efc (diff) | |
download | jinja2-8e01f54765b66c2f5e8bfa316157e5669e940229.tar.gz |
update the Docstring of do_truncate, add useful examples
Diffstat (limited to 'jinja2')
-rw-r--r-- | jinja2/filters.py | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/jinja2/filters.py b/jinja2/filters.py index 8fef6ea..b4152f7 100644 --- a/jinja2/filters.py +++ b/jinja2/filters.py @@ -443,16 +443,17 @@ def do_truncate(s, length=255, killwords=False, end='...'): """Return a truncated copy of the string. The length is specified with the first parameter which defaults to ``255``. If the second parameter is ``true`` the filter will cut the text at length. Otherwise - it will try to save the last word. If the text was in fact + it will discard the last word. If the text was in fact truncated it will append an ellipsis sign (``"..."``). If you want a different ellipsis sign than ``"..."`` you can specify it using the third parameter. - .. sourcecode jinja:: + .. sourcecode:: jinja - {{ mytext|truncate(300, false, '»') }} - truncate mytext to 300 chars, don't split up words, use a - right pointing double arrow as ellipsis sign. + {{ "foo bar"|truncate(5) }} + -> "foo ..." + {{ "foo bar"|truncate(5, True) }} + -> "foo b..." """ if len(s) <= length: return s |