Update map and array examples

m-kuhn · m-kuhn · commit ec4483a51a28 · 2018-08-24T14:04:27.000+02:00
diff --git a/resources/function_help/json/array b/resources/function_help/json/array
@@ -7,6 +7,6 @@
     {"arg":"value1", "syntaxOnly": true},
     {"arg":"value2", "syntaxOnly": true},
     {"arg":"value", "descOnly": true, "description":"a value"}],
-  "examples": [ { "expression":"array(2,10)", "returns":"array: 2, 10"}
+  "examples": [ { "expression":"array(2,10)", "returns":"[ 2, 10 ]"}
   ]
 }
diff --git a/resources/function_help/json/array_append b/resources/function_help/json/array_append
@@ -4,5 +4,5 @@
   "description": "Returns an array with the given value added at the end.",
   "arguments": [ {"arg":"array","description":"an array"},
                  {"arg":"value","description":"the value to add"}],
-  "examples": [ { "expression":"array_append(array(1,2,3),4)", "returns":"array: 1,2,3,4"}]
+  "examples": [ { "expression":"array_append(array(1,2,3),4)", "returns":"[ 1, 2, 3, 4 ]"}]
 }
diff --git a/resources/function_help/json/array_cat b/resources/function_help/json/array_cat
@@ -7,6 +7,6 @@
     {"arg":"array1", "syntaxOnly": true},
     {"arg":"array2", "syntaxOnly": true},
     {"arg":"array", "descOnly": true, "description":"an array"}],
-  "examples": [ { "expression":"array_cat(array(1,2),array(2,3))", "returns":"array: 1,2,2,3"}
+  "examples": [ { "expression":"array_cat(array(1,2),array(2,3))", "returns":"[ 1, 2, 2, 3 ]"}
   ]
 }
diff --git a/resources/function_help/json/array_distinct b/resources/function_help/json/array_distinct
@@ -4,6 +4,6 @@
   "description": "Returns an array containing distinct values of the given array.",
   "arguments": [
     {"arg":"array","description":"an array"}],
-  "examples": [ { "expression":"array_distinct(array(1,2,3,2,1))", "returns":"array: 1,2,3"}
+  "examples": [ { "expression":"array_distinct(array(1,2,3,2,1))", "returns":"[ 1, 2, 3 ]"}
   ]
 }
diff --git a/resources/function_help/json/array_foreach b/resources/function_help/json/array_foreach
@@ -7,7 +7,7 @@
     {"arg":"expression","description":"an expression to evaluate on each item. The variable `@element` will be replaced by the current value."}
   ],
   "examples": [
-    { "expression": "array_foreach(array('a','b','c'),upper(@element))", "returns":"array: 'A', 'B', 'C'"},
-    { "expression": "array_foreach(array(1,2,3),@element + 10)", "returns":"array: 11, 12, 13"}
+    { "expression": "array_foreach(array('a','b','c'),upper(@element))", "returns":"[ 'A', 'B', 'C' ]"},
+    { "expression": "array_foreach(array(1,2,3),@element + 10)", "returns":"[ 11, 12, 13 ]"}
   ]
 }
diff --git a/resources/function_help/json/array_insert b/resources/function_help/json/array_insert
@@ -5,5 +5,5 @@
   "arguments": [ {"arg":"array","description":"an array"},
                  {"arg":"pos","description":"the position where to add (0 based)"},
                  {"arg":"value","description":"the value to add"}],
-  "examples": [ { "expression":"array_insert(array(1,2,3),1,100)", "returns":"array: 1,100,2,3"}]
+  "examples": [ { "expression":"array_insert(array(1,2,3),1,100)", "returns":"[ 1, 100, 2, 3 ]"}]
 }
diff --git a/resources/function_help/json/array_prepend b/resources/function_help/json/array_prepend
@@ -4,5 +4,5 @@
   "description": "Returns an array with the given value added at the beginning.",
   "arguments": [ {"arg":"array","description":"an array"},
                  {"arg":"value","description":"the value to add"}],
-  "examples": [ { "expression":"array_prepend(array(1,2,3),0)", "returns":"array: 0,1,2,3"}]
+  "examples": [ { "expression":"array_prepend(array(1,2,3),0)", "returns":"[ 0, 1, 2, 3 ]"}]
 }
diff --git a/resources/function_help/json/array_remove_all b/resources/function_help/json/array_remove_all
@@ -4,5 +4,5 @@
   "description": "Returns an array with all the entries of the given value removed.",
   "arguments": [ {"arg":"array","description":"an array"},
                  {"arg":"value","description":"the values to remove"}],
-  "examples": [ { "expression":"array_remove_all(array('a','b','c','b'),'b')", "returns":"array: 'a','c'"}]
+  "examples": [ { "expression":"array_remove_all(array('a','b','c','b'),'b')", "returns":"[ 'a', 'c' ]"}]
 }
diff --git a/resources/function_help/json/array_remove_at b/resources/function_help/json/array_remove_at
@@ -4,5 +4,5 @@
   "description": "Returns an array with the given index removed.",
   "arguments": [ {"arg":"array","description":"an array"},
                  {"arg":"pos","description":"the position to remove (0 based)"}],
-  "examples": [ { "expression":"array_remove_at(array(1,2,3),1)", "returns":"array: 1,3"}]
+  "examples": [ { "expression":"array_remove_at(array(1,2,3),1)", "returns":"[ 1, 3 ]"}]
 }
diff --git a/resources/function_help/json/array_reverse b/resources/function_help/json/array_reverse
@@ -3,5 +3,5 @@
   "type": "function",
   "description": "Returns the given array with array values in reversed order.",
   "arguments": [ {"arg":"array","description":"an array"} ],
-  "examples": [ { "expression":"array_reverse(array(2,4,0,10))", "returns":"array: 10,0,4,2"}]
+  "examples": [ { "expression":"array_reverse(array(2,4,0,10))", "returns":"[ 10, 0, 4, 2 ]"}]
 }
diff --git a/resources/function_help/json/array_slice b/resources/function_help/json/array_slice
@@ -17,35 +17,35 @@
         ],
         "examples": [{
                         "expression": "array_slice(array(1,2,3,4,5),0,3)",
-                        "returns": "array: 1,2,3,4"
+                        "returns": "[ 1, 2, 3, 4 ]"
                 },
                 {
                         "expression": "array_slice(array(1,2,3,4,5),0,-1)",
-                        "returns": "array: 1,2,3,4,5"
+                        "returns": "[ 1, 2, 3, 4, 5 ]"
                 },
                 {
                         "expression": "array_slice(array(1,2,3,4,5),-5,-1)",
-                        "returns": "array: 1,2,3,4,5"
+                        "returns": "[ 1, 2, 3, 4, 5 ]"
                 },
                 {
                         "expression": "array_slice(array(1,2,3,4,5),0,0)",
-                        "returns": "array: 1"
+                        "returns": "[ 1 ]"
                 },
                 {
                         "expression": "array_slice(array(1,2,3,4,5),-2,-1)",
-                        "returns": "array: 4,5"
+                        "returns": "[ 4, 5 ]"
                 },
                 {
                         "expression": "array_slice(array(1,2,3,4,5),-1,-1)",
-                        "returns": "array: 5"
+                        "returns": "[ 5 ]"
                 },
                 {
                         "expression": "array_slice(array('Dufour','Valmiera','Chugiak','Brighton'),1,2)",
-                        "returns": "array: 'Valmiera','Chugiak'"
+                        "returns": "[ 'Valmiera', 'Chugiak' ]"
                 },
                 {
                         "expression": "array_slice(array_slice(array('Dufour','Valmiera','Chugiak','Brighton'),-2,-1)",
-                        "returns": "array: 'Chugiak','Brighton'"
+                        "returns": "[ 'Chugiak', 'Brighton' ]"
                 }
         ]
 }
diff --git a/resources/function_help/json/generate_series b/resources/function_help/json/generate_series
@@ -7,7 +7,7 @@
     {"arg":"stop", "description":"value that ends the sequence once reached"},
     {"arg":"step","optional":true,"default":"1","description":"value used as the increment between values"}
   ],
-  "examples": [ { "expression":"generate_series('1,5)", "returns":"array: '1', '2', '3', '4', '5'"},
-                { "expression":"generate_series('5,1,-1)", "returns":"array: '5', '4', '3', '2', '1'"}
+  "examples": [ { "expression":"generate_series('1,5)", "returns":"[ 1, 2, 3, 4, 5 ]"},
+                { "expression":"generate_series('5,1,-1)", "returns":"[ 5, 4, 3, 2, 1 ]"}
   ]
 }
diff --git a/resources/function_help/json/map b/resources/function_help/json/map
@@ -10,6 +10,6 @@
     {"arg":"value2", "syntaxOnly": true},
     {"arg":"key", "descOnly": true, "description":"a key (string)"},
     {"arg":"value", "descOnly": true, "description":"a value"}],
-  "examples": [ { "expression":"map('1','one','2', 'two')", "returns":"map: 1: 'one', 2: 'two'"}
+  "examples": [ { "expression":"map('1','one','2', 'two')", "returns":"{ '1': 'one', '2': 'two' }"}
   ]
 }
diff --git a/resources/function_help/json/map_akeys b/resources/function_help/json/map_akeys
@@ -3,5 +3,5 @@
   "type": "function",
   "description": "Returns all the keys of a map as an array.",
   "arguments": [ {"arg":"map","description":"a map"}],
-  "examples": [ { "expression":"map_akeys(map('1','one','2','two'))", "returns":"array: '1', '2'"}]
+  "examples": [ { "expression":"map_akeys(map('1','one','2','two'))", "returns":"[ '1', '2' ]"}]
 }
diff --git a/resources/function_help/json/map_avals b/resources/function_help/json/map_avals
@@ -3,5 +3,5 @@
   "type": "function",
   "description": "Returns all the values of a map as an array.",
   "arguments": [ {"arg":"map","description":"a map"}],
-  "examples": [ { "expression":"map_avals(map('1','one','2','two'))", "returns":"array: 'one', 'two'"}]
+  "examples": [ { "expression":"map_avals(map('1','one','2','two'))", "returns":"[ 'one', 'two' ]"}]
 }
diff --git a/resources/function_help/json/map_concat b/resources/function_help/json/map_concat
@@ -7,6 +7,6 @@
     {"arg":"map1", "syntaxOnly": true},
     {"arg":"map2", "syntaxOnly": true},
     {"arg":"map", "descOnly": true, "description":"a map"}],
-  "examples": [ { "expression":"map_concat(map('1','one', '2','overridden'),map('2','two', '3','three'))", "returns":"map: 1: 'one, 2: 'two', 3: 'three'"}
+  "examples": [ { "expression":"map_concat(map('1','one', '2','overridden'),map('2','two', '3','three'))", "returns":"{ '1': 'one, '2': 'two', '3': 'three' }"}
   ]
 }
diff --git a/resources/function_help/json/map_delete b/resources/function_help/json/map_delete
@@ -4,5 +4,5 @@
   "description": "Returns a map with the given key and its corresponding value deleted.",
   "arguments": [ {"arg":"map","description":"a map"},
                  {"arg":"key","description":"the key to delete"}],
-  "examples": [ { "expression":"map_delete(map('1','one','2','two'),'2')", "returns":"map: 1: 'one'"}]
+  "examples": [ { "expression":"map_delete(map('1','one','2','two'),'2')", "returns":"{ '1': 'one' }"}]
 }
diff --git a/resources/function_help/json/map_insert b/resources/function_help/json/map_insert
@@ -5,5 +5,5 @@
   "arguments": [ {"arg":"map","description":"a map"},
                  {"arg":"key","description":"the key to add"},
                  {"arg":"value","description":"the value to add"}],
-  "examples": [ { "expression":"map_insert(map('1','one'),'3','three')", "returns":"map: 1: 'one', 3: 'three'"}]
+  "examples": [ { "expression":"map_insert(map('1','one'),'3','three')", "returns":"{ '1': 'one', '3': 'three' }"}]
 }
diff --git a/resources/function_help/json/regexp_matches b/resources/function_help/json/regexp_matches
@@ -6,7 +6,7 @@
     {"arg":"string", "description":"the string to capture groups from against the regular expression"},
     {"arg":"regex","description":"the regular expression used to capture groups"},
     {"arg":"empty_value","optional":true,"default":"''","description":"the optional string to use as replacement for empty (zero length) matches"}],
-  "examples": [ { "expression":"regexp_matches('QGIS=>rocks','(.*)=>(.*)')", "returns":"array: 'QGIS', 'rocks'"},
-                { "expression":"regexp_matches('key=>','(.*)=>(.*)','empty value')", "returns":"array: 'key', 'empty value'"}
+  "examples": [ { "expression":"regexp_matches('QGIS=>rocks','(.*)=>(.*)')", "returns":"[ 'QGIS', 'rocks' ]"},
+                { "expression":"regexp_matches('key=>','(.*)=>(.*)','empty value')", "returns":"[ 'key', 'empty value' ]"}
   ]
 }
diff --git a/resources/function_help/json/string_to_array b/resources/function_help/json/string_to_array
@@ -6,7 +6,7 @@
     {"arg":"string", "description":"the input string"},
     {"arg":"delimiter","optional":true,"default":"','","description":"the string delimiter used to split the input string"},
     {"arg":"empty_value","optional":true,"default":"''","description":"the optional string to use as replacement for empty (zero length) matches"}],
-  "examples": [ { "expression":"string_to_array('1,2,3',',')", "returns":"array: '1', '2', '3'"},
-                { "expression":"string_to_array('1,,3',',','0')", "returns":"array: '1', '0', '3'"}
+  "examples": [ { "expression":"string_to_array('1,2,3',',')", "returns":"[ '1', '2', '3' ]"},
+                { "expression":"string_to_array('1,,3',',','0')", "returns":"[ '1', '0', '3' ]"}
   ]
 }

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@`
`7`	`7`	`{"arg":"value1", "syntaxOnly": true},`
`8`	`8`	`{"arg":"value2", "syntaxOnly": true},`
`9`	`9`	`{"arg":"value", "descOnly": true, "description":"a value"}],`
`10`		`- "examples": [ { "expression":"array(2,10)", "returns":"array: 2, 10"}`
	`10`	`+ "examples": [ { "expression":"array(2,10)", "returns":"[ 2, 10 ]"}`
`11`	`11`	`]`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@`
`4`	`4`	`"description": "Returns an array with the given value added at the end.",`
`5`	`5`	`"arguments": [ {"arg":"array","description":"an array"},`
`6`	`6`	`{"arg":"value","description":"the value to add"}],`
`7`		`- "examples": [ { "expression":"array_append(array(1,2,3),4)", "returns":"array: 1,2,3,4"}]`
	`7`	`+ "examples": [ { "expression":"array_append(array(1,2,3),4)", "returns":"[ 1, 2, 3, 4 ]"}]`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@`
`7`	`7`	`{"arg":"array1", "syntaxOnly": true},`
`8`	`8`	`{"arg":"array2", "syntaxOnly": true},`
`9`	`9`	`{"arg":"array", "descOnly": true, "description":"an array"}],`
`10`		`- "examples": [ { "expression":"array_cat(array(1,2),array(2,3))", "returns":"array: 1,2,2,3"}`
	`10`	`+ "examples": [ { "expression":"array_cat(array(1,2),array(2,3))", "returns":"[ 1, 2, 2, 3 ]"}`
`11`	`11`	`]`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@`
`4`	`4`	`"description": "Returns an array containing distinct values of the given array.",`
`5`	`5`	`"arguments": [`
`6`	`6`	`{"arg":"array","description":"an array"}],`
`7`		`- "examples": [ { "expression":"array_distinct(array(1,2,3,2,1))", "returns":"array: 1,2,3"}`
	`7`	`+ "examples": [ { "expression":"array_distinct(array(1,2,3,2,1))", "returns":"[ 1, 2, 3 ]"}`
`8`	`8`	`]`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	{"arg":"expression","description":"an expression to evaluate on each item. The variable `@element` will be replaced by the current value."}
`8`	`8`	`],`
`9`	`9`	`"examples": [`
`10`		`- { "expression": "array_foreach(array('a','b','c'),upper(@element))", "returns":"array: 'A', 'B', 'C'"},`
`11`		`- { "expression": "array_foreach(array(1,2,3),@element + 10)", "returns":"array: 11, 12, 13"}`
	`10`	`+ { "expression": "array_foreach(array('a','b','c'),upper(@element))", "returns":"[ 'A', 'B', 'C' ]"},`
	`11`	`+ { "expression": "array_foreach(array(1,2,3),@element + 10)", "returns":"[ 11, 12, 13 ]"}`
`12`	`12`	`]`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,5 @@`
`5`	`5`	`"arguments": [ {"arg":"array","description":"an array"},`
`6`	`6`	`{"arg":"pos","description":"the position where to add (0 based)"},`
`7`	`7`	`{"arg":"value","description":"the value to add"}],`
`8`		`- "examples": [ { "expression":"array_insert(array(1,2,3),1,100)", "returns":"array: 1,100,2,3"}]`
	`8`	`+ "examples": [ { "expression":"array_insert(array(1,2,3),1,100)", "returns":"[ 1, 100, 2, 3 ]"}]`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@`
`4`	`4`	`"description": "Returns an array with all the entries of the given value removed.",`
`5`	`5`	`"arguments": [ {"arg":"array","description":"an array"},`
`6`	`6`	`{"arg":"value","description":"the values to remove"}],`
`7`		`- "examples": [ { "expression":"array_remove_all(array('a','b','c','b'),'b')", "returns":"array: 'a','c'"}]`
	`7`	`+ "examples": [ { "expression":"array_remove_all(array('a','b','c','b'),'b')", "returns":"[ 'a', 'c' ]"}]`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"type": "function",`
`4`	`4`	`"description": "Returns the given array with array values in reversed order.",`
`5`	`5`	`"arguments": [ {"arg":"array","description":"an array"} ],`
`6`		`- "examples": [ { "expression":"array_reverse(array(2,4,0,10))", "returns":"array: 10,0,4,2"}]`
	`6`	`+ "examples": [ { "expression":"array_reverse(array(2,4,0,10))", "returns":"[ 10, 0, 4, 2 ]"}]`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,35 +17,35 @@`
`17`	`17`	`],`
`18`	`18`	`"examples": [{`
`19`	`19`	`"expression": "array_slice(array(1,2,3,4,5),0,3)",`
`20`		`- "returns": "array: 1,2,3,4"`
	`20`	`+ "returns": "[ 1, 2, 3, 4 ]"`
`21`	`21`	`},`
`22`	`22`	`{`
`23`	`23`	`"expression": "array_slice(array(1,2,3,4,5),0,-1)",`
`24`		`- "returns": "array: 1,2,3,4,5"`
	`24`	`+ "returns": "[ 1, 2, 3, 4, 5 ]"`
`25`	`25`	`},`
`26`	`26`	`{`
`27`	`27`	`"expression": "array_slice(array(1,2,3,4,5),-5,-1)",`
`28`		`- "returns": "array: 1,2,3,4,5"`
	`28`	`+ "returns": "[ 1, 2, 3, 4, 5 ]"`
`29`	`29`	`},`
`30`	`30`	`{`
`31`	`31`	`"expression": "array_slice(array(1,2,3,4,5),0,0)",`
`32`		`- "returns": "array: 1"`
	`32`	`+ "returns": "[ 1 ]"`
`33`	`33`	`},`
`34`	`34`	`{`
`35`	`35`	`"expression": "array_slice(array(1,2,3,4,5),-2,-1)",`
`36`		`- "returns": "array: 4,5"`
	`36`	`+ "returns": "[ 4, 5 ]"`
`37`	`37`	`},`
`38`	`38`	`{`
`39`	`39`	`"expression": "array_slice(array(1,2,3,4,5),-1,-1)",`
`40`		`- "returns": "array: 5"`
	`40`	`+ "returns": "[ 5 ]"`
`41`	`41`	`},`
`42`	`42`	`{`
`43`	`43`	`"expression": "array_slice(array('Dufour','Valmiera','Chugiak','Brighton'),1,2)",`
`44`		`- "returns": "array: 'Valmiera','Chugiak'"`
	`44`	`+ "returns": "[ 'Valmiera', 'Chugiak' ]"`
`45`	`45`	`},`
`46`	`46`	`{`
`47`	`47`	`"expression": "array_slice(array_slice(array('Dufour','Valmiera','Chugiak','Brighton'),-2,-1)",`
`48`		`- "returns": "array: 'Chugiak','Brighton'"`
	`48`	`+ "returns": "[ 'Chugiak', 'Brighton' ]"`
`49`	`49`	`}`
`50`	`50`	`]`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`{"arg":"stop", "description":"value that ends the sequence once reached"},`
`8`	`8`	`{"arg":"step","optional":true,"default":"1","description":"value used as the increment between values"}`
`9`	`9`	`],`
`10`		`- "examples": [ { "expression":"generate_series('1,5)", "returns":"array: '1', '2', '3', '4', '5'"},`
`11`		`- { "expression":"generate_series('5,1,-1)", "returns":"array: '5', '4', '3', '2', '1'"}`
	`10`	`+ "examples": [ { "expression":"generate_series('1,5)", "returns":"[ 1, 2, 3, 4, 5 ]"},`
	`11`	`+ { "expression":"generate_series('5,1,-1)", "returns":"[ 5, 4, 3, 2, 1 ]"}`
`12`	`12`	`]`
`13`	`13`	`}`