From 793f52771411869855193aa690b5fd26b43a90a2 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Tue, 11 Feb 2014 11:45:18 +0100 Subject: [PATCH] Documentation minor corrections --- doc/en/examples.rst | 10 +++++----- doc/en/index.rst | 1 + doc/en/reference.rst | 14 +++++++------- doc/fr/index.rst | 1 + 4 files changed, 14 insertions(+), 12 deletions(-) diff --git a/doc/en/examples.rst b/doc/en/examples.rst index 3792e53..2485285 100644 --- a/doc/en/examples.rst +++ b/doc/en/examples.rst @@ -210,8 +210,8 @@ shown by the following figure: There is only one command changing, with "*3DVAR*" value in the "*Algorithm*" field instead of "*Blue*". -Building a estimation case with external data definition by scripts -------------------------------------------------------------------- +Building an estimation case with external data definition by scripts +-------------------------------------------------------------------- It is useful to get parts or all of the data from external definition, using Python script files to provide access to the data. As an example, we build here @@ -577,9 +577,9 @@ Building the case with external data definition by scripts All these scripts can then be used to define the ADAO case with external data definition by Python script files. It is entirely similar to the method -described in the `Building a simple estimation case with external data -definition by scripts`_ previous section. For each variable to be defined, we -select the "*Script*" option of the "*FROM*" keyword, which leads to a +described in the `Building an estimation case with external data definition by +scripts`_ previous section. For each variable to be defined, we select the +"*Script*" option of the "*FROM*" keyword, which leads to a "*SCRIPT_DATA/SCRIPT_FILE*" entry in the tree. For the "*ObservationOperator*" keyword, we choose the "*ScriptWithOneFunction*" form and keep the default differential increment. diff --git a/doc/en/index.rst b/doc/en/index.rst index 4b875e7..b0dca15 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -57,4 +57,5 @@ Indices and tables * :ref:`genindex` * :ref:`search` + .. * :ref:`section_glossary` diff --git a/doc/en/reference.rst b/doc/en/reference.rst index 64b8fb0..dd35f17 100644 --- a/doc/en/reference.rst +++ b/doc/en/reference.rst @@ -231,7 +231,7 @@ following: provided to help the user to start or to quickly make his case. Optional and required commands for calculation algorithms -++++++++--++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. index:: single: 3DVAR .. index:: single: Blue @@ -712,12 +712,12 @@ commands are the following: and associated parameters in the following subsection `Optional and required commands for checking algorithms`_. -**AlgorithmParameters** - *Optional command*. This command allows to add some optional parameters to - control the data assimilation or optimization algorithm. It is defined as a - "*Dict*" type object, that is, given as a script. See below the list of - algorithms and associated parameters in the following subsection `Options - and required commands for checking algorithms`_. +**AlgorithmParameters** *Optional command*. This command allows to add some + optional parameters to control the data assimilation or optimization + algorithm. It is defined as a "*Dict*" type object, that is, given as a + script. See below the list of algorithms and associated parameters in the + following subsection `Optional and required commands for checking + algorithms`_. **CheckingPoint** *Required command*. This indicates the vector used, previously noted as diff --git a/doc/fr/index.rst b/doc/fr/index.rst index a501238..60ad64a 100644 --- a/doc/fr/index.rst +++ b/doc/fr/index.rst @@ -64,4 +64,5 @@ Index et tables * :ref:`genindex` * :ref:`search` + .. * :ref:`section_glossary` -- 2.39.2