Skip to content

Commit 0cec717

Browse files
committed
docs: make description more precise
1 parent 9766069 commit 0cec717

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

user_guide_src/source/outgoing/view_renderer.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,18 @@ View Renderer Options
116116

117117
Several options can be passed to the ``render()`` or ``renderString()`` methods:
118118

119-
- ``cache`` - the time in seconds, to save a view's results; ignored for renderString()
120-
- ``cache_name`` - the ID used to save/retrieve a cached view result; defaults to the viewpath; ignored for ``renderString()``
121-
- ``saveData`` - true if the view data parameters should be retained for subsequent calls
122-
123-
.. note:: ``saveData()`` as defined by the interface must be a boolean, but implementing
119+
- ``$options``
120+
121+
- ``cache`` - the time in seconds, to save a view's results; ignored for
122+
``renderString()``.
123+
- ``cache_name`` - the ID used to save/retrieve a cached view result; defaults
124+
to the ``$viewPath``; ignored for ``renderString()``.
125+
- ``debug`` - can be set to false to disable the addition of debug code for
126+
:ref:`Debug Toolbar <the-debug-toolbar>`.
127+
- ``$saveData`` - true if the view data parameters should be retained for
128+
subsequent calls.
129+
130+
.. note:: ``$saveData`` as defined by the interface must be a boolean, but implementing
124131
classes (like ``View`` below) may extend this to include ``null`` values.
125132

126133
***************

0 commit comments

Comments
 (0)