Skip to content

Commit 8259b61

Browse files
committed
Added info about caching behaviour to docstrings
1 parent 5ce56d1 commit 8259b61

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

adafruit_templateengine.py

+12
Original file line numberDiff line numberDiff line change
@@ -777,6 +777,9 @@ def render_string_iter(
777777
Creates a `Template` from the given ``template_string`` and renders it using the provided
778778
``context``. Returns a generator that yields the rendered output.
779779
780+
If `cache` is ``True``, the template is saved and reused on next calls, even with different
781+
contexts.
782+
780783
:param dict context: Dictionary containing the context for the template
781784
:param int chunk_size: Size of the chunks to be yielded. If ``None``, the generator yields
782785
the template in chunks sized specifically for the given template
@@ -817,6 +820,9 @@ def render_string(
817820
Creates a `Template` from the given ``template_string`` and renders it using the provided
818821
``context``. Returns the rendered output as a string.
819822
823+
If `cache` is ``True``, the template is saved and reused on next calls, even with different
824+
contexts.
825+
820826
:param dict context: Dictionary containing the context for the template
821827
:param bool cache: When ``True``, the template is saved and reused on next calls.
822828
@@ -849,6 +855,9 @@ def render_template_iter(
849855
Creates a `FileTemplate` from the given ``template_path`` and renders it using the provided
850856
``context``. Returns a generator that yields the rendered output.
851857
858+
If `cache` is ``True``, the template is saved and reused on next calls, even with different
859+
contexts.
860+
852861
:param dict context: Dictionary containing the context for the template
853862
:param int chunk_size: Size of the chunks to be yielded. If ``None``, the generator yields
854863
the template in chunks sized specifically for the given template
@@ -889,6 +898,9 @@ def render_template(
889898
Creates a `FileTemplate` from the given ``template_path`` and renders it using the provided
890899
``context``. Returns the rendered output as a string.
891900
901+
If `cache` is ``True``, the template is saved and reused on next calls, even with different
902+
contexts.
903+
892904
:param dict context: Dictionary containing the context for the template
893905
:param bool cache: When ``True``, the template is saved and reused on next calls.
894906

0 commit comments

Comments
 (0)