doc for the settings

This commit is contained in:
gwen 2012-11-19 16:48:47 +01:00
parent 86f9096937
commit e13fec23fe
4 changed files with 10 additions and 16 deletions

View file

@ -79,4 +79,3 @@ def process_modules():
parse_module(modname)
process_modules()

View 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:

View 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()`

View 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()