christianlight/tutor
7
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-06-07 08:30:48 +00:00
Code Issues Releases Activity

docs: improve plugin defaults readability

Browse Source
This commit is contained in:
Crist Ye 2021-12-08 17:28:55 +08:00 committed by Régis Behmo
parent c3e6f57b08
commit ddcfab2ddb
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/plugins/api.rst
View File

@ -11,7 +11,7 @@ config
The ``config`` attribute is used to modify existing and add new configuration parameters:
* ``config["add"]`` are key/values that should be added to the user-specific ``config.yml`` configuration. Add there passwords, secret keys and other values that do not have a default value.
* ``config["defaults"]`` are default key/values for this plugin. These values will not be added to the ``config.yml`` user file unless users override them manually with ``tutor config save --set ...``.
* ``config["defaults"]`` are default key/values for this plugin. These values can be accessed even though they are not added to the ``config.yml`` user file. Users can override them manually with ``tutor config save --set ...``.
* ``config["set"]`` are existing key/values that should be modified. Be very careful what you add there! Different plugins may define conflicting values for some parameters.
"add" and "defaults" key names will be automatically prefixed with the plugin name, in upper case.