From 76310dd2c29e8ff120687a7698947907252a5fbc Mon Sep 17 00:00:00 2001 From: Jeroen Versteeg Date: Tue, 27 Aug 2024 10:49:57 +0200 Subject: [PATCH] Adjust documentation for types tag based on fabpot's review --- doc/tags/types.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/tags/types.rst b/doc/tags/types.rst index dae401d3141..e2f5090b795 100644 --- a/doc/tags/types.rst +++ b/doc/tags/types.rst @@ -1,9 +1,9 @@ ``types`` -======= +========= -The ``types`` tag declares the types for one or more names variables. +The ``types`` tag declares the types for template variables. -To do this, specify a :ref:`mapping ` of names to their types as string constants. +To do this, specify a :ref:`mapping ` of names to their types as strings. Here is how you declare that variable ``foo`` is a boolean, while ``bar`` is an integer (see note below): @@ -14,9 +14,7 @@ Here is how you declare that variable ``foo`` is a boolean, while ``bar`` is an bar: 'int', } %} -You may put these all on one line. However, using one line per variable improves readability. - -This tag has no effect on the template's output or runtime behavior. +By default, this tag does not affect the template compilation or runtime behavior. Its purpose is to enable designers and developers to document and specify the context's available and/or required variables.