From 269e5d5b353b458e39fabb1892a50808ecadec31 Mon Sep 17 00:00:00 2001 From: gwen Date: Tue, 22 May 2012 11:42:57 +0200 Subject: [PATCH] doc update --- doc/consistency.txt | 10 +++++++++- doc/glossary.txt | 11 +++++++---- doc/todo.txt | 3 +-- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/doc/consistency.txt b/doc/consistency.txt index 873b0f2..4b00606 100644 --- a/doc/consistency.txt +++ b/doc/consistency.txt @@ -69,7 +69,15 @@ This type of validation is very open. Let's take a use case : an option has a certain value, and the value of this option can change the owner of another option or option group... Everything is possible. -FIXME : put an example here +For example, the configuration paths have to be unique in the +:ref:`glossary#schema`, the validation is carried out at the +:api:`config.Config._cfgimpl_build()` time in the +:api:`config.Config._validate_duplicates()` method. + +Other hook are availables to validate upon a whole configuration at any +time. + +.. FIXME : get the validates hooks from the original config pypy's code Identical option names ---------------------- diff --git a/doc/glossary.txt b/doc/glossary.txt index 06f0616..e041090 100644 --- a/doc/glossary.txt +++ b/doc/glossary.txt @@ -67,15 +67,18 @@ glossary **disabled option** - FIXME + a disabled option has a different behaviour on regards to the access + of the value in the configuration, see :doc:`status` for more details. **fill option** - FIXME - + a fill option is like an automatic option except that it is + calculated only if a value hasn't been set. + **auto option** - FIXME + an automatic option is an option thas is carried out by an external + calculation .. _mandatory: diff --git a/doc/todo.txt b/doc/todo.txt index 1da6c8b..7f89337 100644 --- a/doc/todo.txt +++ b/doc/todo.txt @@ -28,7 +28,7 @@ mettre une contrainte de temps dans le cache globalement dans toute la config - mettre une contrainte de temps donnée - time = 1000 + expires = timestamp + deltatime :date: 17 avril @@ -97,7 +97,6 @@ type option (dérivé de ChoiceOPtion) dans lequel il y a des nouvelles valeurs possibles (pas de validations) ou plutôt une StringOption qui propose un choix de valeurs par défault de type liste. - :date: 24 mars - hide pour les sous-sous config (récursivement) et pas seulement une