Skip to content

Commit 4829b3f

Browse files
committed
small doc tweaks
1 parent 6870b2b commit 4829b3f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

doc/framework.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -154,13 +154,15 @@ On-demand variables
154154
~~~~~~~~~~~~~~~~~~~
155155

156156
On-demand variables are like regular variables, except that their
157-
value is not intended to be computed systematically, e.g., at each
158-
time step of a simulation, but instead only at a given few
159-
times. These are declared using :func:`~xsimlab.on_demand` and must
160-
implement in the same process-ified class a dedicated method that
161-
computes their value. They have always ``intent='out'``.
162-
163-
On-demand variables are useful, e.g., for model diagnostics.
157+
value is not intended to be computed systematically, e.g., at the
158+
beginning or at each time step of a simulation, but instead only at a
159+
given few times (or not at all). These are declared using
160+
:func:`~xsimlab.on_demand` and must implement in the same
161+
process-ified class a dedicated method -- i.e., decorated with
162+
``@foo.compute`` where ``foo`` is the name of the variable -- that
163+
returns their value. They have always ``intent='out'``.
164+
165+
On-demand variables are useful, e.g., for optional model diagnostics.
164166

165167
Simulation workflow
166168
-------------------

0 commit comments

Comments
 (0)