add known issues

Julien Verneuil
1 parent 8bc205ab
Showing 1 changed file with 32 additions and 0 deletions Show diff stats
file_processor_io/yaml/yaml_parser.anubis
@@ -6,6 +6,38 @@
  * © Calexium 
  */
  
+/*
+ * YAML parser
+ * 
+ * Known issues: 
+ *  - A list at the same level of a key which is not in a root node is ignored
+ *    Example ("Key" value will be of type "null"): 
+ *              RootNode:
+ *                Key:
+ *                - ignored list item
+ *                - ignored list item
+ * 
+ *  - The parser fail to parse correctly this sort of list :
+ *              RootNode:
+ *                - Key1: value
+ *                  Key2: value
+ *                  Key3: value
+ *                - Key4: value
+ * 
+ *    Key1, Key2, Key3 will be parsed as list items independently and not as a single list item made of multiple keys
+ * 
+ *  - Lists and "objects" which are not in a block are not implemented yet
+ *    Example :
+ *              Node: [item1, item2]
+ *         or :
+ *              Node: {key1: value, key2: value}
+ * 
+ *  - Double quoted and single quoted nodes are not implemented yet
+ *    Example :
+ *              "Node": value
+ *              'Node': value
+ */
+
  
 read yaml_type.anubis
 read tools/streams.anubis