Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Triple quotes in docs #2064

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Triple quotes in docs #2064

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6998ab
Make ease of use update to template documentation
ratchek Dec 13, 2023
8a8eafc
edit block assignment section
davidism Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/templates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1086,34 +1086,34 @@ Assignments use the `set` tag and can have multiple targets::
Block Assignments
~~~~~~~~~~~~~~~~~

.. versionadded:: 2.8
It's possible to use `set` as a block to assign the content of the block to a
variable. This can be used to create multi-line strings, since Jinja doesn't
support Python's triple quotes (``"""``, ``'''``).

Starting with Jinja 2.8, it's possible to also use block assignments to
capture the contents of a block into a variable name. This can be useful
in some situations as an alternative for macros. In that case, instead of
using an equals sign and a value, you just write the variable name and then
everything until ``{% endset %}`` is captured.
Instead of using an equals sign and a value, you only write the variable name,
and everything until ``{% endset %}`` is captured.

Example::
.. code-block:: jinja

{% set navigation %}
<li><a href="/">Index</a>
<li><a href="/downloads">Downloads</a>
{% endset %}

The `navigation` variable then contains the navigation HTML source.

.. versionchanged:: 2.10

Starting with Jinja 2.10, the block assignment supports filters.
Filters applied to the variable name will be applied to the block's content.

Example::
.. code-block:: jinja

{% set reply | wordwrap %}
You wrote:
{{ message }}
{% endset %}

.. versionadded:: 2.8

.. versionchanged:: 2.10

Block assignment supports filters.

.. _extends:

Expand Down