mirror of
https://github.com/Kozea/Radicale.git
synced 2025-08-01 18:18:31 +00:00
Improve documentation
This commit is contained in:
parent
3d7757fa38
commit
2e4924a0da
6 changed files with 29 additions and 1 deletions
|
@ -294,6 +294,8 @@ class Configuration:
|
|||
|
||||
``schema`` a dict that describes the configuration format.
|
||||
See ``DEFAULT_CONFIG_SCHEMA``.
|
||||
The content of ``schema`` must not change afterwards, it is kept
|
||||
as an internal reference.
|
||||
|
||||
Use ``load()`` to create an instance for use with
|
||||
``radicale.app.Application``.
|
||||
|
@ -316,6 +318,8 @@ class Configuration:
|
|||
|
||||
``config`` a dict of the format {SECTION: {OPTION: VALUE, ...}, ...}.
|
||||
The configuration is checked for errors according to the config schema.
|
||||
The content of ``config`` must not change afterwards, it is kept
|
||||
as an internal reference.
|
||||
|
||||
``source`` a description of the configuration source (used in error
|
||||
messages).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue