summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Lord <davidism@gmail.com>2021-04-05 14:18:56 -0700
committerGitHub <noreply@github.com>2021-04-05 14:18:56 -0700
commite45eabccf0424ea9406ba56549b084e7854c5922 (patch)
tree5aca2dabc8d661628f1465f95440e3a8da31059c /docs
parent851f7aff5775235e62f43176b95cd1d786f4b18b (diff)
parent0fa20045b0d2bf06f11a2bab005d9bd986525eda (diff)
downloadjinja2-e45eabccf0424ea9406ba56549b084e7854c5922.tar.gz
Merge pull request #1236 from sixtyfathoms/fix/issue-1184
Update wording on dictionary default ordering
Diffstat (limited to 'docs')
-rw-r--r--docs/templates.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/templates.rst b/docs/templates.rst
index 4f0c9db..3afa71f 100644
--- a/docs/templates.rst
+++ b/docs/templates.rst
@@ -688,9 +688,17 @@ iterate over containers like `dict`::
{% endfor %}
</dl>
-Note, however, that **Python dicts are not ordered**; so you might want to
-either pass a sorted ``list`` of ``tuple`` s -- or a
-``collections.OrderedDict`` -- to the template, or use the `dictsort` filter.
+Python dicts may not be in the order you want to display them in. If
+order matters, use the ``|dictsort`` filter.
+
+.. code-block:: jinja
+
+ <dl>
+ {% for key, value in my_dict | dictsort %}
+ <dt>{{ key|e }}</dt>
+ <dd>{{ value|e }}</dd>
+ {% endfor %}
+ </dl>
Inside of a for-loop block, you can access some special variables: