Add some documentation surrounding Jinja comments - refs #24492, #21217, #23359

This commit is contained in:
Tim Baker 2015-06-11 03:42:31 -04:00 committed by rallytime
parent f23f99ec35
commit 6a917471d4

View file

@ -46,6 +46,13 @@ Here's a more complex example:
.. code-blocK:: jinja
# Comments in yaml start with a hash symbol.
# If you want to include jinja in the comments
# you may need to escape them using 'jinja' comments to prevent
# jinja from trying to rendering something which is not well-defined jinja.
# e.g.
# {# iterate over the Three Stooges using a {% for %}..{% endfor %} loop
# with the iterator variable {{ usr }} becoming the state ID. #}
{% for usr in 'moe','larry','curly' %}
{{ usr }}:
group:
@ -216,4 +223,4 @@ Next steps
In :doc:`part 4 <states_pt4>` we will discuss how to use salt's
:conf_master:`file_roots` to set up a workflow in which states can be
"promoted" from dev, to QA, to production.
"promoted" from dev, to QA, to production.