Extend aggregate's concatenator and order_by args description

qgis · Aug 9, 2020 · 1d0749d · 1d0749d
1 parent 57b620c
commit 1d0749d
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/resources/function_help/json/aggregate b/resources/function_help/json/aggregate
@@ -9,7 +9,7 @@
 	{"arg":"expression", "description":"sub expression or field name to aggregate"},
 	{"arg":"filter", "optional":true, "description":"optional filter expression to limit the features used for calculating the aggregate. Fields and geometry are from the features on the joined layer. The source feature can be accessed with the variable @parent."},
 	{"arg":"concatenator", "optional":true, "default":"''", "description":"optional string to use to join values for 'concatenate' aggregate"},
-	{"arg":"order_by", "optional":true, "description":"optional filter expression to order the features used for calculating the aggregate. Fields and geometry are from the features on the joined layer. By default, no sort is done"}
+	{"arg":"order_by", "optional":true, "description":"optional filter expression to order the features used for calculating the aggregate. Fields and geometry are from the features on the joined layer. By default, the features will be returned in an unspecified order."}
   ],
   "examples": [
 	{ "expression":"aggregate(layer:='rail_stations',aggregate:='sum',expression:=\"passengers\")", "returns":"sum of all values from the passengers field in the rail_stations layer"},

diff --git a/resources/function_help/json/array_agg b/resources/function_help/json/array_agg
@@ -7,7 +7,7 @@
     {"arg": "expression", "description": "sub expression of field to aggregate"},
     {"arg": "group_by", "optional": true, "description": "optional expression to use to group aggregate calculations"},
     {"arg": "filter", "optional": true, "description": "optional expression to use to filter features used to calculate aggregate"},
-    {"arg": "order_by", "optional": true, "description": "optional expression to use to order features used to calculate aggregate"}
+    {"arg": "order_by", "optional": true, "description": "optional expression to use to order features used to calculate aggregate. By default, the features will be returned in an unspecified order."}
   ],
   "examples": [
     { "expression": "array_agg(\"name\",group_by:=\"state\")", "returns":"list of name values, grouped by state field"}

diff --git a/resources/function_help/json/concatenate b/resources/function_help/json/concatenate
@@ -7,8 +7,8 @@
 	{"arg":"expression", "description":"sub expression of field to aggregate"},
 	{"arg":"group_by", "optional":true, "description":"optional expression to use to group aggregate calculations"},
 	{"arg":"filter", "optional":true, "description":"optional expression to use to filter features used to calculate aggregate"},
-	{"arg":"concatenator", "optional":true, "description":"optional string to use to join values"},
-	{"arg":"order_by", "optional":true, "description":"optional expression to use to order features used to calculate aggregate"}
+	{"arg":"concatenator", "optional":true, "default":"''", "description":"optional string to use to join values"},
+	{"arg":"order_by", "optional":true, "description":"optional expression to use to order features used to calculate aggregate. By default, the features will be returned in an unspecified order."}
   ],
   "examples": [
 	{ "expression":"concatenate(\"town_name\",group_by:=\"state\",concatenator:=',')", "returns":"comma separated list of town_names, grouped by state field"}

diff --git a/resources/function_help/json/concatenate_unique b/resources/function_help/json/concatenate_unique
@@ -7,8 +7,8 @@
 	{"arg":"expression", "description":"sub expression of field to aggregate"},
 	{"arg":"group_by", "optional":true, "description":"optional expression to use to group aggregate calculations"},
 	{"arg":"filter", "optional":true, "description":"optional expression to use to filter features used to calculate aggregate"},
-	{"arg":"concatenator", "optional":true, "description":"optional string to use to join values"},
-	{"arg":"order_by", "optional":true, "description":"optional expression to use to order features used to calculate aggregate"}
+	{"arg":"concatenator", "optional":true, "default":"''", "description":"optional string to use to join values"},
+	{"arg":"order_by", "optional":true, "description":"optional expression to use to order features used to calculate aggregate. By default, the features will be returned in an unspecified order."}
   ],
   "examples": [
 	{ "expression":"concatenate(\"town_name\",group_by:=\"state\",concatenator:=',')", "returns":"comma separated list of unique town_names, grouped by state field"}

diff --git a/resources/function_help/json/relation_aggregate b/resources/function_help/json/relation_aggregate
@@ -7,8 +7,8 @@
 	{"arg":"relation", "description":"a string, representing a relation ID"},
 	{"arg":"aggregate", "description":"a string corresponding to the aggregate to calculate. Valid options are:<br /><ul><li>count</li><li>count_distinct</li><li>count_missing</li><li>min</li><li>max</li><li>sum</li><li>mean</li><li>median</li><li>stdev</li><li>stdevsample</li><li>range</li><li>minority</li><li>majority</li><li>q1: first quartile</li><li>q3: third quartile</li><li>iqr: inter quartile range</li><li>min_length: minimum string length</li><li>max_length: maximum string length</li><li>concatenate: join strings with a concatenator</li><li>concatenate_unique: join unique strings with a concatenator</li><li>collect: create an aggregated multipart geometry</li><li>array_agg: create an array of aggregated values</li></ul>"},
 	{"arg":"expression", "description":"sub expression or field name to aggregate"},
-	{"arg":"concatenator", "optional":true, "description":"optional string to use to join values for 'concatenate' aggregate"},
-	{"arg":"order_by", "optional":true, "description":"optional expression to order the features used for calculating the aggregate. Fields and geometry are from the features on the joined layer."}
+	{"arg":"concatenator", "optional":true, "default":"''", "description":"optional string to use to join values for 'concatenate' aggregate"},
+	{"arg":"order_by", "optional":true, "description":"optional expression to order the features used for calculating the aggregate. Fields and geometry are from the features on the joined layer. By default, the features will be returned in an unspecified order."}
   ],
   "examples": [
 	{ "expression":"relation_aggregate(relation:='my_relation',aggregate:='mean',expression:=\"passengers\")", "returns":"mean value of all matching child features using the 'my_relation' relation"},