From b281d682f26ab04edd8eca79b99dbbc6afeb1f89 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Villemot?= <sebastien@dynare.org>
Date: Mon, 14 Sep 2020 18:42:04 +0200
Subject: [PATCH] =?UTF-8?q?Manual:=20document=20default=20name=20for=20?=
=?UTF-8?q?=E2=80=9Cshock=5Fgroups=E2=80=9D=20blocks?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
By the way, fix the syntax description for the name (it needs *not* be quoted).
[skip ci]
---
doc/manual/source/the-model-file.rst | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/doc/manual/source/the-model-file.rst b/doc/manual/source/the-model-file.rst
index daa60ee8e9..a9c154ab4b 100644
--- a/doc/manual/source/the-model-file.rst
+++ b/doc/manual/source/the-model-file.rst
@@ -7551,11 +7551,12 @@ Shock Decomposition
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
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
@@ -7624,7 +7625,8 @@ Shock Decomposition
groups. It is possible to use several ``shock_groups`` blocks
in a model file, each grouping being identified by a different
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*
@@ -7703,9 +7705,9 @@ Shock Decomposition
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
@@ -7846,9 +7848,9 @@ Shock Decomposition
*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
--
GitLab