Clarify what the "date" filter takes as parameter
authorUplink03 <radu.cx+github@gmail.com>
Tue, 3 Sep 2013 15:25:30 +0000 (16:25 +0100)
committerUplink03 <radu.cx+github@gmail.com>
Tue, 3 Sep 2013 15:25:30 +0000 (16:25 +0100)
Clarify what the "date" filter takes as parameter.

I went through Twig/Extension/Core.php to figure what's happening. I haven't verified that I'm actually correct, but it looks like I am.

doc/filters/date.rst

index 8e2f31f..3fb3005 100644 (file)
@@ -18,6 +18,10 @@ The ``date`` filter formats a date to a given format:
 .. code-block:: jinja
 
     {{ post.published_at|date("m/d/Y") }}
+    
+The format specifier is the same as supported by `date`_,
+except when the filtered data is of type `DateInterval`_, when the format must conform to
+`DateInterval::format`_ instead.
 
 The ``date`` filter accepts strings (it must be in a format supported by the
 `strtotime`_ function), `DateTime`_ instances, or `DateInterval`_ instances. For
@@ -86,3 +90,5 @@ Arguments
 .. _`strtotime`:    http://www.php.net/strtotime
 .. _`DateTime`:     http://www.php.net/DateTime
 .. _`DateInterval`: http://www.php.net/DateInterval
+.. _`date`: http://www.php.net/date
+.. _`DateInterval::format`: http://www.php.net/DateInterval.format