added documentation for the trim filter
authorFabien Potencier <fabien.potencier@gmail.com>
Thu, 22 Mar 2012 13:34:27 +0000 (14:34 +0100)
committerFabien Potencier <fabien.potencier@gmail.com>
Thu, 22 Mar 2012 13:34:27 +0000 (14:34 +0100)
doc/filters/trim.rst [new file with mode: 0644]

diff --git a/doc/filters/trim.rst b/doc/filters/trim.rst
new file mode 100644 (file)
index 0000000..f1215f6
--- /dev/null
@@ -0,0 +1,24 @@
+``trim``
+========
+
+.. versionadded:: 1.6.2
+    The trim filter was added in Twig 1.6.2.
+
+The ``trim`` filter strips whitespace (or other characters) from the beginning
+and end of a string:
+
+.. code-block:: jinja
+
+    {{ '  I like Twig.  '|trim }}
+
+    {# outputs 'I like Twig.' #}
+
+    {{ '  I like Twig.'|trim('.') }}
+
+    {# outputs '  I like Twig' #}
+
+.. note::
+
+    Internally, Twig uses the PHP `trim`_ function.
+
+.. _`trim`: http://php.net/trim