documentation update
authorgwen <gremond@cadoles.com>
Tue, 20 Aug 2013 15:30:24 +0000 (17:30 +0200)
committergwen <gremond@cadoles.com>
Tue, 20 Aug 2013 15:30:24 +0000 (17:30 +0200)
doc/consistency.txt
doc/glossary.txt
doc/status.txt

index 31e9817..b7d0ddf 100644 (file)
@@ -8,8 +8,8 @@ The global consistency
 Identical option names
 ----------------------
 
-If an `option.Option()` happens to be defined twice in the
-`glossary#schema` (e.g. the `option.OptionDescription()`),
+If an :class:`~option.Option()` happens to be defined twice in the
+:term:`schema` (e.g. the :class:`~option.OptionDescription()`),
 that is the two options actually have the same name, an exception is raised.
 
 The calculation is currently carried out in the samespace, for example
index 783381b..a23136e 100644 (file)
@@ -15,7 +15,7 @@ Glossary
     schema
     option description
 
-        see `option.OptionDescription`, see `option#schema`
+        see :class:`tiramisu.option.OptionDescription`
 
         The schema of a configuration :
 
@@ -97,8 +97,7 @@ Glossary
     mandatory option
 
         A mandatory option is a configuration option wich value has to be
-        set, that is the default value cannot be `None`, see
-        `optionapi#optioninit`
+        set, that is the default value cannot be `None`.
 
 .. glossary::
 
index 87a62c0..f7f9183 100644 (file)
@@ -19,8 +19,8 @@ method:
     properties, except for the `hidden` configuration options but, yes, it is
     possible to modify a disabled option.
 
-    To enable read-write status, call
-    :class:`config.CommonConfig.read_write()`
+    To enable read-write status, call 
+    :class:`~config.CommonConfig.read_write()` on the config.
 
 **read only status**
 
@@ -31,7 +31,8 @@ method:
     The configuration has not an access to the hidden options
     but can read the disabled options.
 
-    To enable read only status, call :class:`config.SubConfig.read_only()`
+    To enable read only status, call :class:`~config.SubConfig.read_only()` on 
+    the config.
 
 .. csv-table:: **Configuration's statuses summary**
    :header: " ", "Hidden", "Disabled", "Mandatory"