Function help improvements

m-kuhn · m-kuhn · commit 2b5830ec9c00 · 2018-12-18T14:54:58.000+01:00
diff --git a/resources/function_help/json/decode_uri b/resources/function_help/json/decode_uri
@@ -3,10 +3,10 @@
   "type": "function",
   "description": "Takes a layer and decodes the uri of the underlying data provider. It depends on the dataprovider, which data is available.",
   "arguments": [ {"arg":"layer","description":"The layer for which the uri should be decoded."},
-                 {"arg":"part","description":"The part of the uri to return. If unspecified, a map with all uri parts will be returned."} ],
+                 {"arg":"part","description":"The part of the uri to return. If unspecified, a map with all uri parts will be returned.","optional":true} ],
   "examples": [ { "expression":"decode_uri(@layer)", "returns":"{'layerId': '0', 'layerName': '', 'path': '/home/qgis/shapefile.shp'}"},
                 { "expression":"decode_uri(@layer)", "returns":"{'layerId': NULL, 'layerName': 'layer', 'path': '/home/qgis/geopackage.gpkg'}"},
-                { "expression":"decode_uri(@layer), 'path'", "returns":"'C:\my_data\qgis\shape.shp'"}
+                { "expression":"decode_uri(@layer, 'path')", "returns":"'C:\my_data\qgis\shape.shp'"}
               ]
 }
 

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,10 @@`
`3`	`3`	`"type": "function",`
`4`	`4`	`"description": "Takes a layer and decodes the uri of the underlying data provider. It depends on the dataprovider, which data is available.",`
`5`	`5`	`"arguments": [ {"arg":"layer","description":"The layer for which the uri should be decoded."},`
`6`		`- {"arg":"part","description":"The part of the uri to return. If unspecified, a map with all uri parts will be returned."} ],`
	`6`	`+ {"arg":"part","description":"The part of the uri to return. If unspecified, a map with all uri parts will be returned.","optional":true} ],`
`7`	`7`	`"examples": [ { "expression":"decode_uri(@layer)", "returns":"{'layerId': '0', 'layerName': '', 'path': '/home/qgis/shapefile.shp'}"},`
`8`	`8`	`{ "expression":"decode_uri(@layer)", "returns":"{'layerId': NULL, 'layerName': 'layer', 'path': '/home/qgis/geopackage.gpkg'}"},`
`9`		`- { "expression":"decode_uri(@layer), 'path'", "returns":"'C:\my_data\qgis\shape.shp'"}`
	`9`	`+ { "expression":"decode_uri(@layer, 'path')", "returns":"'C:\my_data\qgis\shape.shp'"}`
`10`	`10`	`]`
`11`	`11`	`}`
`12`	`12`