Verified Commit 553615ef authored by Sébastien Villemot's avatar Sébastien Villemot
Browse files

Manual: fix the description of the “colormap” option

This option takes as argument the name of MATLAB/Octave variable, not a string.

Ref #1586
parent e4a9ee09
...@@ -6956,11 +6956,13 @@ Shock Decomposition ...@@ -6956,11 +6956,13 @@ Shock Decomposition
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.
.. option:: colormap = STRING .. option:: colormap = VARIABLE_NAME
Controls the ``colormap`` used for the shocks decomposition Controls the ``colormap`` used for the shocks decomposition graphs.
graphs. See colormap in MATLAB/Octave manual for valid VARIABLE_NAME must be the name of a MATLAB/Octave variable that has
arguments. been declared beforehand and whose value will be passed to the
MATLAB/Octave ``colormap`` function (see the MATLAB/Octave manual for
the list of acceptable values).
.. option:: nograph .. option:: nograph
...@@ -7099,9 +7101,9 @@ Shock Decomposition ...@@ -7099,9 +7101,9 @@ Shock Decomposition
See :opt:`use_shock_groups <use_shock_groups [= STRING]>`. See :opt:`use_shock_groups <use_shock_groups [= STRING]>`.
.. option:: colormap = STRING .. option:: colormap = VARIABLE_NAME
See :opt:`colormap <colormap = STRING>`. See :opt:`colormap <colormap = VARIABLE_NAME>`.
.. option:: nograph .. option:: nograph
...@@ -7238,9 +7240,9 @@ Shock Decomposition ...@@ -7238,9 +7240,9 @@ Shock Decomposition
See :opt:`use_shock_groups <use_shock_groups [= STRING]>`. See :opt:`use_shock_groups <use_shock_groups [= STRING]>`.
.. option:: colormap = STRING .. option:: colormap = VARIABLE_NAME
See :opt:`colormap <colormap = STRING>`. See :opt:`colormap <colormap = VARIABLE_NAME>`.
.. option:: nodisplay .. option:: nodisplay
...@@ -7387,9 +7389,9 @@ Shock Decomposition ...@@ -7387,9 +7389,9 @@ Shock Decomposition
*Options* *Options*
.. option:: colormap = STRING .. option:: colormap = VARIABLE_NAME
See :opt:`colormap <colormap = STRING>`. See :opt:`colormap <colormap = VARIABLE_NAME>`.
.. option:: nodisplay .. option:: nodisplay
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment