doc is ready for the new api refactoring

This commit is contained in:
gwen
2013-05-21 11:37:39 +02:00
parent d6098f353e
commit 9acb522791
7 changed files with 35 additions and 98 deletions

View File

@ -108,6 +108,7 @@ class Option(BaseInformation):
:param validator: the name of a function wich stands for a custom
validation of the value
:param validator_args: the validator's parameters
"""
if not valid_name(name):
raise ValueError(_("invalid name: {0} for option").format(name))
@ -606,14 +607,16 @@ class DomainnameOption(Option):
class OptionDescription(BaseInformation):
"""Config's schema (organisation, group) and container of Options"""
"""Config's schema (organisation, group) and container of Options
The `OptionsDescription` objects lives in the `tiramisu.config.Config`.
"""
__slots__ = ('_name', '_requires', '_cache_paths', '_group_type',
'_properties', '_children', '_consistencies')
def __init__(self, name, doc, children, requires=None, properties=None):
"""
:param children: is a list of option descriptions (including
``OptionDescription`` instances for nested namespaces).
:param children: a list of options (including option descriptions)
"""
if not valid_name(name):
raise ValueError(_("invalid name: {0} for option descr").format(name))