From 553615efbc491491a5bc9661e43e3c891601fc87 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Villemot?= <sebastien@dynare.org>
Date: Mon, 9 Dec 2019 15:52:24 +0100
Subject: [PATCH] =?UTF-8?q?Manual:=20fix=20the=20description=20of=20the=20?=
=?UTF-8?q?=E2=80=9Ccolormap=E2=80=9D=20option?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
This option takes as argument the name of MATLAB/Octave variable, not a string.
Ref #1586
---
doc/manual/source/the-model-file.rst | 22 ++++++++++++----------
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/doc/manual/source/the-model-file.rst b/doc/manual/source/the-model-file.rst
index a88f173bfb..dedafd797f 100644
--- a/doc/manual/source/the-model-file.rst
+++ b/doc/manual/source/the-model-file.rst
@@ -6956,11 +6956,13 @@ Shock Decomposition
individual shocks in the decomposition. The groups of shocks
are defined in the :bck:`shock_groups` block.
- .. option:: colormap = STRING
+ .. option:: colormap = VARIABLE_NAME
- Controls the ``colormap`` used for the shocks decomposition
- graphs. See colormap in MATLAB/Octave manual for valid
- arguments.
+ Controls the ``colormap`` used for the shocks decomposition graphs.
+ VARIABLE_NAME must be the name of a MATLAB/Octave variable that has
+ 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
@@ -7099,9 +7101,9 @@ Shock Decomposition
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
@@ -7238,9 +7240,9 @@ Shock Decomposition
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
@@ -7387,9 +7389,9 @@ Shock Decomposition
*Options*
- .. option:: colormap = STRING
+ .. option:: colormap = VARIABLE_NAME
- See :opt:`colormap <colormap = STRING>`.
+ See :opt:`colormap <colormap = VARIABLE_NAME>`.
.. option:: nodisplay
--
GitLab