From 067bca6e5852bd170becaad55dd05af28cdb7d25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20M=C3=A4kel=C3=A4?= Date: Wed, 20 Jun 2018 20:58:59 +0300 Subject: [PATCH] Document comment syntax Documented comment syntax and explicitly stated that trailing comments are not supported. --- Documentation/Getting-Started/Configuration-Guide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Documentation/Getting-Started/Configuration-Guide.md b/Documentation/Getting-Started/Configuration-Guide.md index 2793c862e..ee4e3bf12 100644 --- a/Documentation/Getting-Started/Configuration-Guide.md +++ b/Documentation/Getting-Started/Configuration-Guide.md @@ -82,6 +82,14 @@ The values of the parameter that are not on the first line need to have at least one whitespace character before them in order for them to be recognized as a part of the multi-line parameter. +Comments are defined by prefixing a row with a hash (`#`). Trailing comments are +not supported. + +``` +# This is a comment before a parameter +some_parameter=123 +``` + ### Special Parameter Types #### Sizes