update of the doc
This commit is contained in:
@ -36,6 +36,7 @@ class Config(object):
|
||||
|
||||
def __init__(self, descr, parent=None, context=None):
|
||||
""" Configuration option management master class
|
||||
|
||||
:param descr: describes the configuration schema
|
||||
:type descr: an instance of ``option.OptionDescription``
|
||||
:param parent: is None if the ``Config`` is root parent Config otherwise
|
||||
@ -226,7 +227,8 @@ class Config(object):
|
||||
def setoption(self, name, value, who=None):
|
||||
"""effectively modifies the value of an Option()
|
||||
(typically called by the __setattr__)
|
||||
:param who : an object that lives in `setting.owners`
|
||||
|
||||
:param who: an object that lives in `setting.owners`
|
||||
"""
|
||||
child = getattr(self._cfgimpl_descr, name)
|
||||
if type(child) != SymLinkOption:
|
||||
@ -258,6 +260,7 @@ class Config(object):
|
||||
do what I mean"-interface to option setting. Searches all paths
|
||||
starting from that config for matches of the optional arguments
|
||||
and sets the found option if the match is not ambiguous.
|
||||
|
||||
:param kwargs: dict of name strings to values.
|
||||
"""
|
||||
all_paths = [p.split(".") for p in self.getpaths(allpaths=True)]
|
||||
@ -377,6 +380,7 @@ class Config(object):
|
||||
"""iteration on groups objects only.
|
||||
All groups are returned if `group_type` is `None`, otherwise the groups
|
||||
can be filtered by categories (families, or whatever).
|
||||
|
||||
:param group_type: if defined, is an instance of `groups.GroupType`
|
||||
or `groups.MasterGroupType` that lives in
|
||||
`setting.groups`
|
||||
|
Reference in New Issue
Block a user