docs: yaml settings quoting

CS-SI · Feb 13, 2024 · 9f6e860 · 9f6e860
1 parent 622012a
commit 9f6e860
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/getting_started_guide/configure.rst b/docs/getting_started_guide/configure.rst
@@ -58,6 +58,11 @@ one (e.g. credentials). *PEPS*'s configuration template is shown below:
 
    </details>
 
+.. note::
+
+   Please write settings values as plain text, without quotes to avoid ``PyYAML`` interpreting potential special
+   characters. See https://pyyaml.org/wiki/PyYAMLDocumentation for more information.
+
 |
 
 Users can directly modify the default file, which is then loaded automatically: