Infra
/
tiramisu
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc

This commit is contained in:
gwen 2013-09-05 16:56:02 +02:00
parent dc688ad644
commit e73f3e0e6c
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/config.txt
View File

@ -145,7 +145,7 @@ let's come back to the default value
value value
The value is saved in a :class:`~tiramisu.value.Value` object. It is on this The value is saved in a :class:`~tiramisu.value.Value` object. It is on this
object that we have to trigger the `reset`, wich take the option itself object that we have to trigger the `reset`, which take the option itself
(`var2`) as a parameter. (`var2`) as a parameter.
On the other side, in the `read_only` mode, it is not possible to modify the value On the other side, in the `read_only` mode, it is not possible to modify the value
@ -415,7 +415,7 @@ A multi-option's value can be manipulated like a list::
>>> print c.od1.var1 >>> print c.od1.var1
[u'var1'] [u'var1']
But it is not possible to set a value to a multi-option wich is not a list:: But it is not possible to set a value to a multi-option which is not a list::
>>> c.od1.var1 = u'error' >>> c.od1.var1 = u'error'
Traceback (most recent call last): Traceback (most recent call last):
@ -543,6 +543,6 @@ Here are the (useful) methods on ``Config`` (or `SubConfig`).
A :class:`~config.CommonConfig` is a abstract base class. A A :class:`~config.CommonConfig` is a abstract base class. A
:class:`~config.SubConfig` is an just in time created objects that wraps an :class:`~config.SubConfig` is an just in time created objects that wraps an
::class:`~option.OptionDescription`. A SubConfig differs from a Config in the ::class:`~option.OptionDescription`. A SubConfig differs from a Config in the
::fact that a config is a root object and has an environnement, a context wich fact that a config is a root object and has an environnement, a context which
::defines the different properties, access rules, vs... There is generally only defines the different properties, access rules, vs... There is generally only
::one Config, and many SubConfigs. one Config, and many SubConfigs.

4
doc/getting-started.txt
View File

@ -14,7 +14,7 @@ introduced...
What is Tiramisu ? What is Tiramisu ?
=================== ===================
Tiramisu is an options handler and an options controller, wich aims at Tiramisu is an options handler and an options controller, which aims at
producing flexible and fast options access. The main advantages are its access producing flexible and fast options access. The main advantages are its access
rules and the fact that the whole consistency is preserved at any time, see rules and the fact that the whole consistency is preserved at any time, see
:doc:`consistency`. There is of course type and structure validations, but also :doc:`consistency`. There is of course type and structure validations, but also
@ -65,7 +65,7 @@ So by now, we have:
- a namespace (which is `c` here) - a namespace (which is `c` here)
- the access of an option's value by the - the access of an option's value by the
attribute access way (here `bool`, wich is a boolean option attribute access way (here `bool`, which is a boolean option
:class:`~tiramisu.option.BoolOption()`. :class:`~tiramisu.option.BoolOption()`.
So, option objects are produced at the entry point `c` and then handed down to So, option objects are produced at the entry point `c` and then handed down to