Changeset 6143

Timestamp:

09/13/07 18:30:26 (1 year ago)

Author:

mtredinnick

Message:

Fixed #4793 -- Tweaked custom filter documentation a little to possibly reduce some confusion. Thanks, SmileyChris?.

Files:

• django/trunk/docs/templates_python.txt (modified) (2 diffs)

django/trunk/docs/templates_python.txt

@@ -643 +643 @@
-        return value.lower()
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-your ``Library`` instance, to make it available to Django's template language::
-
@@ -659 +675 @@
-
-    @register.filter(name='cut')
+    @stringfilter
-    def cut(value, arg):
-        return value.replace(arg, '')
-
-    @register.filter
-    def lower(value):
-        return value.lower()
-
-If you leave off the ``name`` argument, as in the second example above, Django
-will use the function's name as the filter name.
-
-Template filters which expect strings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you are writing a template filter which only expects a string as the first
-argument, you should use the included decorator ``stringfilter`` which will convert
-an object to it's string value before being passed to your function::
-
-    from django.template.defaultfilters import stringfilter
-
-    @stringfilter
-    def lower(value):
-        return value.lower()
+
+If you leave off the ``name`` argument, as in the second example above, Django
+will use the function's name as the filter name.
-
-Writing custom template tags