From b46651ae7ca6c693bee634e397e5872b4537ff99 Mon Sep 17 00:00:00 2001 From: gwen Date: Wed, 14 Nov 2012 11:30:11 +0100 Subject: [PATCH] reset() doc --- doc/config.txt | 5 ++--- doc/configapi.txt | 5 +---- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/doc/config.txt b/doc/config.txt index 799d3ae..c670b6b 100644 --- a/doc/config.txt +++ b/doc/config.txt @@ -90,9 +90,8 @@ name of the option are separated by dots: e.g. the value of the option. 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 -value `None`. An option accepts a type value as a setting, but also `None` as -a possible value. +worry, an option value can be "reseted" with the help of the :api:`option.Option.reset()` +method. 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 diff --git a/doc/configapi.txt b/doc/configapi.txt index 314b03b..dd8b6a7 100644 --- a/doc/configapi.txt +++ b/doc/configapi.txt @@ -33,10 +33,6 @@ Here are the (useful) methods on ``Config``: describes the configuration object. ``override`` can be used to 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)`: "do what I mean"-interface to option setting. Searches all paths 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, - compare two configs (equality), - export the whole config into a `dict` with :api:`config.make_dict()`, + .. - `validate()` an option value into a config, see :doc:`consistency`. :api:`option.Option()` objects in a config are iterable in the pythonic