stove/tiramisu
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

reset() doc

Browse source
This commit is contained in:
gwen 2012-11-14 11:30:11 +01:00
parent 09dba4b959
commit b46651ae7c
2 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/config.txt
View file

@ -90,9 +90,8 @@ name of the option are separated by dots: e.g.
the value of the option. the value of the option.
What if a value has been set and `None` is to be returned again ? Don't What if a value has been set and `None` is to be returned again ? Don't
worry, an option value can be "reseted" just by the affectation of the special worry, an option value can be "reseted" with the help of the :api:`option.Option.reset()`
value `None`. An option accepts a type value as a setting, but also `None` as method.
a possible value.
If you do not want to use the pythonic way, that is the attribute access If you do not want to use the pythonic way, that is the attribute access
way to obtain the value of the configuration option, you can also search way to obtain the value of the configuration option, you can also search

5
doc/configapi.txt
View file

@ -33,10 +33,6 @@ Here are the (useful) methods on ``Config``:
describes the configuration object. ``override`` can be used to describes the configuration object. ``override`` can be used to
set different default values (see method ``override``). set different default values (see method ``override``).
:api:`config.Config.override(self, overrides)`:
override default values. This marks the overridden values as defaults.
``overrides`` is a dictionary of path strings to values.
:api:`config.Config.set(self, **kwargs)`: :api:`config.Config.set(self, **kwargs)`:
"do what I mean"-interface to option setting. Searches all paths "do what I mean"-interface to option setting. Searches all paths
starting from that config for matches of the optional arguments starting from that config for matches of the optional arguments
@ -83,6 +79,7 @@ it is possible to
the order of the :ref:`optionapi#schema` specification entries, the order of the :ref:`optionapi#schema` specification entries,
- compare two configs (equality), - compare two configs (equality),
- export the whole config into a `dict` with :api:`config.make_dict()`, - export the whole config into a `dict` with :api:`config.make_dict()`,
.. - `validate()` an option value into a config, see :doc:`consistency`. .. - `validate()` an option value into a config, see :doc:`consistency`.
:api:`option.Option()` objects in a config are iterable in the pythonic :api:`option.Option()` objects in a config are iterable in the pythonic