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

update doc

Browse Source
This commit is contained in:
Emmanuel Garette
2013-09-14 14:44:33 +02:00
parent 3afcf0322c
commit abbb7a274e
6 changed files with 114 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
tiramisu/option.py
View File

@ -319,7 +319,7 @@ class Option(BaseOption):
"""
Abstract base class for configuration option's.
Reminder: an Option object is **not** a container for the value
Reminder: an Option object is **not** a container for the value.
"""
__slots__ = ('_multi', '_validator', '_default_multi', '_default',
'_callback', '_multitype', '_master_slaves', '__weakref__')
@ -342,9 +342,10 @@ class Option(BaseOption):
:param callback: the name of a function. If set, the function's output
is responsible of the option's value
:param callback_params: the callback's parameter
:param validator: the name of a function wich stands for a custom
:param validator: the name of a function which stands for a custom
validation of the value
:param validator_args: the validator's parameters
:param properties: tuple of default properties
"""
super(Option, self).__init__(name, doc, requires, properties)

8
tiramisu/storage/__init__.py
View File

@ -19,7 +19,13 @@
# the whole pypy projet is under MIT licence
# ____________________________________________________________
"""Storage is basic components used to set Config informations in DB.
"""Config's informations are, by default, volatiles. This means, all values and
settings changes will be lost.
The storage is the system Tiramisu uses to communicate with various DB.
You can specified a persistent storage.
Storage is basic components used to set Config informations in DB.
The primary "entry point" class is the StorageType and it's public
configurator ``set_storage()``.
"""