city_generator2

commit 46c9fb738001e9bf022c547c37bce703a903b91c
parent 04ad5081bad9c15205771052970810e5190db1bb
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Wed, 22 Mar 2023 17:04:04 +0100

Add a few words on yaml syntax

Diffstat:
M
doc/city_generator2-input.5.txt
 | 
10
++++++----

1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/doc/city_generator2-input.5.txt b/doc/city_generator2-input.5.txt
@@ -43,6 +43,10 @@ appearing between quote marks has to be used verbatim in the input, without the
 quote characters. Finally, text introduced by the *#* character in descriptions,
 when not verbatim, is a comment and is not part of the description.
 
+Note however that yaml syntax admits multiple equivalent expressions. Thus, the
+rules given thereafter could have been written differently. Experienced yaml
+users can use any equivalent syntax instead of the one introduced here.
+
 [1] https://yaml.org/
 
 === CITY MAP FILE FORMAT
@@ -89,7 +93,7 @@ _______
                          "   construction_mode: " <cmode-name>
                          "   dataset: " <dataset-name>
                          "   height: " <height>
-                         "   footprint: [" <vertices> "]" # At least 3 vertices
+                         "   footprint: [" <vertices> "]"
 
 <name>               ::= STRING
 
@@ -100,7 +104,7 @@ _______
 
 <height>             ::= <REAL> # in ]0, INF)
 
-<vertices>           ::= <vertex> [ "," <vertices> ]
+<vertices>           ::= <vertex> [ "," <vertices> ] # At least 3 vertices
 
 -------------------------------------
 
@@ -175,11 +179,9 @@ _______
 -------------------------------------
 
 <name>               ::= STRING
-
 ______________
 
 
 == SEE ALSO
-:w
 
 *city_generator2*(1)