Added a more clear example in the cycle() docs
authorBrandon Kelly <brandon@pixelandtonic.com>
Fri, 24 Jan 2014 12:27:48 +0000 (04:27 -0800)
committerBrandon Kelly <brandon@pixelandtonic.com>
Fri, 24 Jan 2014 12:27:48 +0000 (04:27 -0800)
The previous one was potentially misleading if you were focussed on the actual numbers (0 is even, not odd! etc.), and 99% of the time you’re going to be passing loop.index0 into cycle, so I felt that should be included in the example.

doc/functions/cycle.rst

index 94f7008..e343493 100644 (file)
@@ -5,8 +5,11 @@ The ``cycle`` function cycles on an array of values:
 
 .. code-block:: jinja
 
-    {% for i in 0..10 %}
-        {{ cycle(['odd', 'even'], i) }}
+    {% set start_year = date() | date('Y') %}
+    {% set end_year = start_year + 5 %}
+
+    {% for year in start_year..end_year %}
+        {{ cycle(['odd', 'even'], loop.index0) }}
     {% endfor %}
 
 The array can contain any number of values: