From e13fec23feea093de9f6b10f3d410006436d95e6 Mon Sep 17 00:00:00 2001 From: gwen Date: Mon, 19 Nov 2012 16:48:47 +0100 Subject: [PATCH] doc for the settings --- doc/code2html | 5 ++--- doc/configapi.txt | 6 ------ doc/status.txt | 12 ++++++++---- test/test_config.py | 3 --- 4 files changed, 10 insertions(+), 16 deletions(-) diff --git a/doc/code2html b/doc/code2html index 9fd5f16..2c3f388 100755 --- a/doc/code2html +++ b/doc/code2html @@ -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() - diff --git a/doc/configapi.txt b/doc/configapi.txt index dd8b6a7..4e73061 100644 --- a/doc/configapi.txt +++ b/doc/configapi.txt @@ -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: diff --git a/doc/status.txt b/doc/status.txt index 3eb8350..2d73451 100644 --- a/doc/status.txt +++ b/doc/status.txt @@ -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()` diff --git a/test/test_config.py b/test/test_config.py index e7c5192..29850be 100644 --- a/test/test_config.py +++ b/test/test_config.py @@ -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()