Manual: document default name for “shock_groups” blocks
By the way, fix the syntax description for the name (it needs *not* be quoted). [skip ci]time-shift
parent
9a726e6138
commit
b281d682f2
|
@ -7551,11 +7551,12 @@ Shock Decomposition
|
||||||
|
|
||||||
See :opt:`xls_range <xls_range = RANGE>`.
|
See :opt:`xls_range <xls_range = RANGE>`.
|
||||||
|
|
||||||
.. option:: use_shock_groups [= STRING]
|
.. option:: use_shock_groups [= NAME]
|
||||||
|
|
||||||
Uses shock grouping defined by the string instead of
|
Uses shock grouping defined by the string instead of
|
||||||
individual shocks in the decomposition. The groups of shocks
|
individual shocks in the decomposition. The groups of shocks
|
||||||
are defined in the :bck:`shock_groups` block.
|
are defined in the :bck:`shock_groups` block. If no group name is
|
||||||
|
given, ``default`` is assumed.
|
||||||
|
|
||||||
.. option:: colormap = VARIABLE_NAME
|
.. option:: colormap = VARIABLE_NAME
|
||||||
|
|
||||||
|
@ -7624,7 +7625,8 @@ Shock Decomposition
|
||||||
groups. It is possible to use several ``shock_groups`` blocks
|
groups. It is possible to use several ``shock_groups`` blocks
|
||||||
in a model file, each grouping being identified by a different
|
in a model file, each grouping being identified by a different
|
||||||
name. This name must in turn be used in the
|
name. This name must in turn be used in the
|
||||||
``shock_decomposition`` command.
|
``shock_decomposition`` command. If no name is given, ``default`` is
|
||||||
|
used.
|
||||||
|
|
||||||
*Example*
|
*Example*
|
||||||
|
|
||||||
|
@ -7703,9 +7705,9 @@ Shock Decomposition
|
||||||
|
|
||||||
See :opt:`nobs <nobs = INTEGER>`.
|
See :opt:`nobs <nobs = INTEGER>`.
|
||||||
|
|
||||||
.. option:: use_shock_groups [= STRING]
|
.. option:: use_shock_groups [= NAME]
|
||||||
|
|
||||||
See :opt:`use_shock_groups <use_shock_groups [= STRING]>`.
|
See :opt:`use_shock_groups <use_shock_groups [= NAME]>`.
|
||||||
|
|
||||||
.. option:: colormap = VARIABLE_NAME
|
.. option:: colormap = VARIABLE_NAME
|
||||||
|
|
||||||
|
@ -7846,9 +7848,9 @@ Shock Decomposition
|
||||||
|
|
||||||
*Options*
|
*Options*
|
||||||
|
|
||||||
.. option:: use_shock_groups [= STRING]
|
.. option:: use_shock_groups [= NAME]
|
||||||
|
|
||||||
See :opt:`use_shock_groups <use_shock_groups [= STRING]>`.
|
See :opt:`use_shock_groups <use_shock_groups [= NAME]>`.
|
||||||
|
|
||||||
.. option:: colormap = VARIABLE_NAME
|
.. option:: colormap = VARIABLE_NAME
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue