From 110ff633eccf24cca6443ba8e302bf0217a848e7 Mon Sep 17 00:00:00 2001
From: Houtan Bastani <houtan@dynare.org>
Date: Wed, 8 Jan 2020 12:48:39 +0100
Subject: [PATCH] doc: fix typo and formatting
(cherry picked from commit b4479361c12981753853b2c16bdd46397a9c608c)
---
doc/manual/source/dynare-misc-commands.rst | 22 ++++++++++++----------
doc/manual/source/the-model-file.rst | 7 ++++---
2 files changed, 16 insertions(+), 13 deletions(-)
diff --git a/doc/manual/source/dynare-misc-commands.rst b/doc/manual/source/dynare-misc-commands.rst
index 6a0af6eedb..91311da9fa 100644
--- a/doc/manual/source/dynare-misc-commands.rst
+++ b/doc/manual/source/dynare-misc-commands.rst
@@ -167,24 +167,26 @@ Dynare misc commands
A ``1*Nblck`` array of doubles. Current acceptance ratios.
-.. matcomm:: prior [options[, ...]];
+.. matcomm:: prior [OPTIONS[, ...]];
- Prints various informations about the prior distribution depending
- on the options. If no options are provided, the command returns
- the list of available options. Following options are available:
+ Prints information about the prior distribution given the provided
+ options. If no options are provided, the command returns the list of
+ available options.
- ``table``
+ *Options*
+
+ .. option:: table
Prints a table describing the marginal prior distributions
(mean, mode, std., lower and upper bounds, HPD interval).
- ``moments``
+ .. option:: moments
Computes and displays first and second order moments of the
endogenous variables at the prior mode (considering the
linearized version of the model).
- ``moments(distribution)``
+ .. option:: moments(distribution)
Computes and displays the prior mean and prior standard
deviation of the first and second moments of the endogenous
@@ -193,7 +195,7 @@ Dynare misc commands
stored in the ``prior`` subfolder in a
``_endogenous_variables_prior_draws.mat`` file.
- ``optimize``
+ .. option:: optimize
Optimizes the prior density (starting from a random initial
guess). The parameters such that the steady state does not
@@ -203,7 +205,7 @@ Dynare misc commands
defined over such regions, the optimization algorithm may fail
to converge to the true solution (the prior mode).
- ``simulate``
+ .. option:: simulate
Computes the effective prior mass using a Monte-Carlo. Ideally
the effective prior mass should be equal to 1, otherwise
@@ -215,6 +217,6 @@ Dynare misc commands
:math:`p_A\neq p_B \leq 1` so that the prior mass of the
compared models are identical.
- ``plot``
+ .. option:: plot
Plots the marginal prior density.
diff --git a/doc/manual/source/the-model-file.rst b/doc/manual/source/the-model-file.rst
index d7e227ee84..839e7a7870 100644
--- a/doc/manual/source/the-model-file.rst
+++ b/doc/manual/source/the-model-file.rst
@@ -7974,7 +7974,7 @@ The forecast scenario can contain some simple shocks on the exogenous
variables. This shocks are described using the function
``basic_plan``:
-.. matcomm:: HANDLE = basic_plan (HANDLE, 'VAR_NAME', 'SHOCK_TYPE', DATES, MATLAB VECTOR OF DOUBLE | [DOUBLE | EXPR [DOUBLE | | EXPR] ] );
+.. matcomm:: HANDLE = basic_plan (HANDLE, `VAR_NAME', `SHOCK_TYPE', DATES, MATLAB VECTOR OF DOUBLE | [DOUBLE | EXPR [DOUBLE | EXPR] ] );
Adds to the forecast scenario a shock on the exogenous variable
indicated between quotes in the second argument. The shock type
@@ -7992,7 +7992,7 @@ compatible with the constrained path are in this case computed. In
other words, a conditional forecast is performed. This kind of shock
is described with the function ``flip_plan``:
-.. matcomm:: HANDLE = flip_plan (HANDLE, 'VAR_NAME, 'VAR_NAME', 'SHOCK_TYPE', DATES, MATLAB VECTOR OF DOUBLE | [DOUBLE | EXPR [DOUBLE | | EXPR] ] );
+.. matcomm:: HANDLE = flip_plan (HANDLE, `VAR_NAME', `VAR_NAME', `SHOCK_TYPE', DATES, MATLAB VECTOR OF DOUBLE | [DOUBLE | EXPR [DOUBLE | EXPR] ] );
Adds to the forecast scenario a constrained path on the endogenous
variable specified between quotes in the second argument. The
@@ -8049,7 +8049,8 @@ computed with the command ``det_cond_forecast``:
plot(dset_forecast.{'r','e'});
-.. command:: smoother2histval [(OPTIONS...)];
+.. command:: smoother2histval ;
+ smoother2histval(OPTIONS...);
The purpose of this command is to construct initial conditions
(for a subsequent simulation) that are the smoothed values of a
--
GitLab