doc for the settings
authorgwen <gremond@cadoles.com>
Mon, 19 Nov 2012 15:48:47 +0000 (16:48 +0100)
committergwen <gremond@cadoles.com>
Mon, 19 Nov 2012 15:48:47 +0000 (16:48 +0100)
doc/code2html
doc/configapi.txt
doc/status.txt
test/test_config.py

index 9fd5f16..2c3f388 100755 (executable)
@@ -69,14 +69,13 @@ def process_modules():
         pyf = splitext(basename(pyf))[0]
         modname = 'tiramisu.' + pyf
         if not '__init__' in modname:
-            parse_module(modname)        
+            parse_module(modname)
 
     pyfiles = glob(normpath(join(directory, '..', 'test', '*.py')))
     for pyf in pyfiles:
         pyf = splitext(basename(pyf))[0]
         modname = 'test.' + pyf
         if not '__init__' in modname:
-            parse_module(modname)        
+            parse_module(modname)
 
 process_modules()
-
index dd8b6a7..4e73061 100644 (file)
@@ -43,12 +43,6 @@ Here are the (useful) methods on ``Config``:
         the search for the option is performed recursively in the whole
         configuration tree.
 
-    :api:`config.Config.cfgimpl_read_write()`:
-        configuration level `read_write` status, see :doc:`status`
-
-    :api:`config.Config.cfgimpl_read_only()`:
-        configuration level `read_only` status, see :doc:`status`
-
 Here are some private attributes of a `Config()` object, for a
 comprehension of the internal merchanism:
 
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()`
index e7c5192..29850be 100644 (file)
@@ -40,9 +40,6 @@ def test_reset_value():
     assert cfg.gc.dummy == False
     cfg.gc.dummy = True
     assert cfg.gc.dummy == True
-#    dummy = cfg.unwrap_from_path("gc.dummy")
-#    dummy.reset()
-#    cfg.gc.dummy = False
 
 def test_base_config_and_groups():
     descr = make_description()