reset() doc
This commit is contained in:
parent
09dba4b959
commit
b46651ae7c
@ -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
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user