From: Jean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Date: Mon, 19 May 2014 11:10:29 +0000 (+0200)
Subject: Documentation minor corrections and improvements
X-Git-Tag: V7_4_0rc1^0
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=57d93313493aff1420f0c6358d06a93524bbc8ea;p=modules%2Fadao.git

Documentation minor corrections and improvements
---

diff --git a/doc/en/advanced.rst b/doc/en/advanced.rst
index 6b2f285..d5c67c2 100644
--- a/doc/en/advanced.rst
+++ b/doc/en/advanced.rst
@@ -106,6 +106,10 @@ results for further use.
 Getting information on special variables during the ADAO calculation in YACS
 -----------------------------------------------------------------------------
 
+.. index:: single: Observer
+.. index:: single: Observers
+.. index:: single: Observer Template
+
 Some special internal optimization variables, used during calculations, can be
 monitored during the ADAO calculation in YACS. These variables can be printed,
 plotted, saved, etc. This can be done using "*observers*", that are scripts,
diff --git a/doc/en/reference.rst b/doc/en/reference.rst
index 32cc541..76b8746 100644
--- a/doc/en/reference.rst
+++ b/doc/en/reference.rst
@@ -101,12 +101,15 @@ List of commands and keywords for an ADAO calculation case
 .. index:: single: Observation
 .. index:: single: ObservationError
 .. index:: single: ObservationOperator
+.. index:: single: Observer
 .. index:: single: Observers
+.. index:: single: Observer Template
 .. index:: single: OutputVariables
 .. index:: single: Study_name
 .. index:: single: Study_repertory
 .. index:: single: UserDataInit
 .. index:: single: UserPostAnalysis
+.. index:: single: UserPostAnalysis Template
 
 The first set of commands is related to the description of a calculation case,
 that is a *Data Assimilation* procedure or an *Optimization* procedure. The
@@ -360,7 +363,7 @@ acronyms or particular names can be found in the :ref:`genindex` or the
     minimizer, see [Byrd95]_, [Morales11]_ and [Zhu97]_), "TNC" (nonlinear
     constrained minimizer), "CG" (nonlinear unconstrained minimizer), "BFGS"
     (nonlinear unconstrained minimizer), "NCG" (Newton CG minimizer). It is
-    recommended to stay with the default.
+    strongly recommended to stay with the default.
 
   Bounds
     This key allows to define upper and lower bounds for every state variable
@@ -423,7 +426,7 @@ acronyms or particular names can be found in the :ref:`genindex` or the
     minimizer, see [Byrd95]_, [Morales11]_ and [Zhu97]_), "TNC" (nonlinear
     constrained minimizer), "CG" (nonlinear unconstrained minimizer), "BFGS"
     (nonlinear unconstrained minimizer), "NCG" (Newton CG minimizer). It is
-    recommended to stay with the default.
+    strongly recommended to stay with the default.
 
   Bounds
     This key allows to define upper and lower bounds for every state variable
diff --git a/doc/fr/advanced.rst b/doc/fr/advanced.rst
index 0b4344e..576e58a 100644
--- a/doc/fr/advanced.rst
+++ b/doc/fr/advanced.rst
@@ -112,6 +112,10 @@ ou de rassembler les r
 Obtenir des informations sur des variables spéciales au cours d'un calcul ADAO en YACS
 --------------------------------------------------------------------------------------
 
+.. index:: single: Observer
+.. index:: single: Observers
+.. index:: single: Observer Template
+
 Certaines variables spéciales internes à l'optimisation, utilisées au cours des
 calculs, peuvent être surveillées durant un calcul ADAO en YACS. Ces variables
 peuvent être affichées, tracées, enregistrées, etc. C'est réalisable en
diff --git a/doc/fr/reference.rst b/doc/fr/reference.rst
index 852fc6a..b2cfce3 100644
--- a/doc/fr/reference.rst
+++ b/doc/fr/reference.rst
@@ -110,12 +110,15 @@ Liste des commandes et mots-cl
 .. index:: single: Observation
 .. index:: single: ObservationError
 .. index:: single: ObservationOperator
+.. index:: single: Observer
 .. index:: single: Observers
+.. index:: single: Observer Template
 .. index:: single: OutputVariables
 .. index:: single: Study_name
 .. index:: single: Study_repertory
 .. index:: single: UserDataInit
 .. index:: single: UserPostAnalysis
+.. index:: single: UserPostAnalysis Template
 
 La première série de commandes est liée à la description d'un cas de calcul, qui
 est une procédure d'*Assimilation de Données* ou d'*Optimisation*. Les termes
@@ -379,8 +382,8 @@ trouv
     linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
     (minimisation non linéaire sous contraintes), "CG" (minimisation non
     linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
-    contraintes), "NCG" (minimisation de type gradient conjugué de Newton). On
-    conseille de conserver la valeur par défaut.
+    contraintes), "NCG" (minimisation de type gradient conjugué de Newton). Il
+    est fortement conseillé de conserver la valeur par défaut.
 
   Bounds
     Cette clé permet de définir des bornes supérieure et inférieure pour
@@ -445,8 +448,8 @@ trouv
     linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
     (minimisation non linéaire sous contraintes), "CG" (minimisation non
     linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
-    contraintes), "NCG" (minimisation de type gradient conjugué de Newton). On
-    conseille de conserver la valeur par défaut.
+    contraintes), "NCG" (minimisation de type gradient conjugué de Newton). Il
+    est fortement conseillé de conserver la valeur par défaut.
 
   Bounds
     Cette clé permet de définir des bornes supérieure et inférieure pour