From 47316074fe53ec25ee14177ee53fb62c3901912d Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Sat, 15 Feb 2014 14:01:07 -0500 Subject: [PATCH] Document "|default" Jinja2 filter example. --- docsite/rst/playbooks_variables.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docsite/rst/playbooks_variables.rst b/docsite/rst/playbooks_variables.rst index e8593a33a4..bca0d0f1b1 100644 --- a/docsite/rst/playbooks_variables.rst +++ b/docsite/rst/playbooks_variables.rst @@ -166,6 +166,19 @@ This allows an explicit check with this feature off:: The variable value will be used as is, but the template evaluation will raise an error if it is undefined. + +.. _defaulting_undefined_variables: + +Defaulting Undefined Variables +------------------------------ + +Jinja2 provides a useful 'defaults' filter, that is often a better approach to failing if a variable is not defined. + + {{ some_variable | default(5) }} + +In the above example, if the variable 'some_variable' is not defined, the value used will be 5, rather than an error +being raised. + .. _set_theory_filters: Set Theory Filters