diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-01-18 15:22:58 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-18 15:22:58 +0100 |
| commit | e65736c25cfaf96efbc5a87d485e07502aa87a5f (patch) | |
| tree | 7de7560c769eba095423fdaee794d0b3843b1152 | |
| parent | bc4ce44d771b99f1ac8d49901630bf3d3c343c8a (diff) | |
| parent | 9914b6fc62555424c81918cc72b53291b43a6841 (diff) | |
Merge pull request #35276 from Calinou/doc-configfile-comments
doc: Mention the limited comment support in ConfigFile
| -rw-r--r-- | doc/classes/ConfigFile.xml | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index d99f90d09a..68966b6f59 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -26,6 +26,7 @@ config.save("user://settings.cfg") [/codeblock] Keep in mind that section and property names can't contain spaces. Anything after a space will be ignored on save and on load. + ConfigFiles can also contain manually written comment lines starting with a semicolon ([code];[/code]). Those lines will be ignored when parsing the file. Note that comments will be lost when saving the ConfigFile. This can still be useful for dedicated server configuration files, which are typically never overwritten without explicit user action. </description> <tutorials> </tutorials> |