doc for the settings
[tiramisu.git] / doc / status.txt
index 3eb8350..2d73451 100644 (file)
@@ -8,10 +8,14 @@ Configuration status
         - :api:`test_option_type.py`
         - :api:`test_option_default.py`
 
+
 Available configuration statuses
 ----------------------------------
 
-These configuration statuses corresponds to specific global attributes :
+The configuration's status lives in an :api:`setting.Setting` object.
+This configuration status corresponds to specific attributes or bunch of
+attributes that can be accessed together with some :api:`setting.Setting`
+method:
 
 **read write status**
 
@@ -20,7 +24,7 @@ These configuration statuses corresponds to specific global attributes :
     possible to modify a disabled option.
 
     To enable read-write status, call
-    :api:`config.Config.cfgimpl_read_write()`
+    :api:`setting.Setting.read_write()`
 
 **read only status**
 
@@ -31,7 +35,7 @@ These configuration statuses corresponds to specific global attributes :
     The configuration has not an access to the hidden options
     but can read the disabled options.
 
-    To enable read only status, call :api:`config.Config.cfgimpl_read_only()`
+    To enable read only status, call :api:`setting.Setting.read_only()`
 
 .. csv-table:: **Configuration's statuses summary**
    :header: " ", "Hidden", "Disabled", "Mandatory"
@@ -44,7 +48,7 @@ These configuration statuses corresponds to specific global attributes :
 Freezing a configuration
 ---------------------------
 
-At the configuration level, :api:`config.Config.cfgimpl_freeze()` freezes
+At the configuration level, :api:`setting.Setting.freeze` freezes
 the whole configuration options.
 
 - :api:`test_option_type.test_frozen_value()`