Replace geom parameter with geometry, for harmonization

qgis · Jul 30, 2020 · 490c8ff · 490c8ff
1 parent 813ee5a
commit 490c8ff
Show file tree

Hide file tree

Showing 29 changed files with 54 additions and 54 deletions.
diff --git a/resources/function_help/json/bounds b/resources/function_help/json/bounds
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description":"Returns a geometry which represents the bounding box of an input geometry. Calculations are in the Spatial Reference System of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"} ],
+  "arguments": [ {"arg":"geometry","description":"a geometry"} ],
   "examples": [ { "expression":"bounds($geometry)", "returns":"bounding box of $geometry"}]
 }
 
diff --git a/resources/function_help/json/bounds_height b/resources/function_help/json/bounds_height
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the height of the bounding box of a geometry. Calculations are in the Spatial Reference System of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"bounds_height($geometry)", "returns":"height of bounding box of $geometry"}]
 }
 
diff --git a/resources/function_help/json/bounds_width b/resources/function_help/json/bounds_width
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the width of the bounding box of a geometry. Calculations are in the Spatial Reference System of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"bounds_width($geometry)", "returns":"width of bounding box of $geometry"}]
 }
 
diff --git a/resources/function_help/json/buffer b/resources/function_help/json/buffer
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns a geometry that represents all points whose distance from this geometry is less than or equal to distance. Calculations are in the Spatial Reference System of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"},
+  "arguments": [ {"arg":"geometry","description":"a geometry"},
                  {"arg":"distance","description":"buffer distance in layer units"},
                  {"arg":"segments","optional":true,"default":"8","description":"number of segments to use to represent a quarter circle when a round join style is used. A larger number results in a smoother buffer with more nodes."}],
   "examples": [ { "expression":"buffer($geometry, 10.5)", "returns":"polygon of $geometry buffered by 10.5 units"}]

diff --git a/resources/function_help/json/centroid b/resources/function_help/json/centroid
@@ -3,6 +3,6 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the geometric center of a geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"centroid($geometry)", "returns":"a point geometry"}]
 }
diff --git a/resources/function_help/json/exterior_ring b/resources/function_help/json/exterior_ring
@@ -3,6 +3,6 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns a line string representing the exterior ring of a polygon geometry. If the geometry is not a polygon then the result will be NULL.",
-  "arguments": [ {"arg":"geom","description":"a polygon geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a polygon geometry"}],
   "examples": [ { "expression":"geom_to_wkt(exterior_ring(geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1),( 0.1 0.1, 0.1 0.2, 0.2 0.2, 0.2, 0.1, 0.1 0.1))')))", "returns":"'LineString (-1 -1, 4 0, 4 2, 0 2, -1 -1)'"}]
 }
diff --git a/resources/function_help/json/extrude b/resources/function_help/json/extrude
@@ -4,7 +4,7 @@
   "groups": ["GeometryGroup"],
   "description": "Returns an extruded version of the input (Multi-)Curve or (Multi-)Linestring geometry with an extension specified by x and y.",
   "arguments": [
-    {"arg":"geom","description":"a polygon geometry"},
+    {"arg":"geometry","description":"a polygon geometry"},
     {"arg":"x","description":"x extension, numeric value"},
     {"arg":"y","description":"y extension, numeric value"}
   ],

diff --git a/resources/function_help/json/flip_coordinates b/resources/function_help/json/flip_coordinates
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns a copy of the geometry with the x and y coordinates swapped. Useful for repairing geometries which have had their latitude and longitude values reversed.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"geom_to_wkt(flip_coordinates(make_point(1, 2)))", "returns":"Point (2 1)"}
   ]
 }
diff --git a/resources/function_help/json/force_rhr b/resources/function_help/json/force_rhr
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Forces a geometry to respect the Right-Hand-Rule, in which the area that is bounded by a polygon is to the right of the boundary. In particular, the exterior ring is oriented in a clockwise direction and the interior rings in a counter-clockwise direction.",
-  "arguments": [ {"arg":"geom","description":"a geometry. Any non-polygon geometries are returned unchanged."}],
+  "arguments": [ {"arg":"geometry","description":"a geometry. Any non-polygon geometries are returned unchanged."}],
   "examples": [ { "expression":"geom_to_wkt(force_rhr(geometry:=geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1))')))", "returns":"Polygon ((-1 -1, 0 2, 4 2, 4 0, -1 -1))"}]
 }
 
diff --git a/resources/function_help/json/is_closed b/resources/function_help/json/is_closed
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns true if a line string is closed (start and end points are coincident), or false if a line string is not closed. If the geometry is not a line string then the result will be NULL.",
-  "arguments": [ {"arg":"geom","description":"a line string geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a line string geometry"}],
   "examples": [ { "expression":"is_closed(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))", "returns":"false"},
                 { "expression":"is_closed(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2, 0 0)'))", "returns":"true"}]
 }
diff --git a/resources/function_help/json/is_empty b/resources/function_help/json/is_empty
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns true if a geometry is empty (without coordinates), false if the geometry is not empty and NULL if there is no geometry. See also is_empty_or_null.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"is_empty(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))", "returns":"false"},
                 { "expression":"is_empty(geom_from_wkt('LINESTRING EMPTY'))", "returns":"true"},
                 { "expression":"is_empty(geom_from_wkt('POINT(7 4)'))", "returns":"false"},

diff --git a/resources/function_help/json/is_empty_or_null b/resources/function_help/json/is_empty_or_null
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns true if a geometry is NULL or empty (without coordinates) or false otherwise. This function is like the expression '$geometry IS NULL or is_empty($geometry)'",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"is_empty_or_null(NULL)", "returns":"true"},
                 { "expression":"is_empty_or_null(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))", "returns":"false"},
                 { "expression":"is_empty_or_null(geom_from_wkt('LINESTRING EMPTY'))", "returns":"true"},

diff --git a/resources/function_help/json/is_valid b/resources/function_help/json/is_valid
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns true if a geometry is valid; if it is well-formed in 2D according to the OGC rules.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"is_valid(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2, 0 0)'))", "returns":"true"},
                 { "expression":"is_valid(geom_from_wkt('LINESTRING(0 0)'))", "returns":"false"}]
 }
diff --git a/resources/function_help/json/m b/resources/function_help/json/m
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the m value of a point geometry.",
-  "arguments": [ {"arg":"geom","description":"a point geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a point geometry"}],
   "examples": [ { "expression":"m( geom_from_wkt( 'POINTM(2 5 4)' ) )", "returns":"4"}
   ]
 }
diff --git a/resources/function_help/json/num_points b/resources/function_help/json/num_points
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the number of vertices in a geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"num_points($geometry)", "returns":"number of vertices in $geometry"}]
 }
 
diff --git a/resources/function_help/json/order_parts b/resources/function_help/json/order_parts
@@ -4,7 +4,7 @@
   "groups": ["GeometryGroup"],
   "description": "Orders the parts of a MultiGeometry by a given criteria",
   "arguments": [
-    {"arg":"geom","description":"a multi-type geometry"},
+    {"arg":"geometry","description":"a multi-type geometry"},
     {"arg":"orderby","description":"an expression string defining the order criteria"},
     {"arg":"ascending","description":"boolean, True for ascending, False for descending"}
   ],

diff --git a/resources/function_help/json/point_on_surface b/resources/function_help/json/point_on_surface
@@ -3,6 +3,6 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns a point guaranteed to lie on the surface of a geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"point_on_surface($geometry)", "returns":"a point geometry"}]
 }
diff --git a/resources/function_help/json/reverse b/resources/function_help/json/reverse
@@ -3,6 +3,6 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Reverses the direction of a line string by reversing the order of its vertices.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"geom_to_wkt(reverse(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)')))", "returns":"'LINESTRING(2 2, 1 1, 0 0)'"}]
 }
diff --git a/resources/function_help/json/rotate b/resources/function_help/json/rotate
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns a rotated version of a geometry. Calculations are in the Spatial Reference System of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"},
+  "arguments": [ {"arg":"geometry","description":"a geometry"},
                  {"arg":"rotation","description":"clockwise rotation in degrees"},
                  {"arg":"point", "optional":true,"description":"rotation center point. If not specified, the center of the geometry's bounding box is used."}
                ],

diff --git a/resources/function_help/json/transform b/resources/function_help/json/transform
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the geometry transformed from a source CRS to a destination CRS.",
-  "arguments": [ {"arg":"geom","description":"a geometry"},
+  "arguments": [ {"arg":"geometry","description":"a geometry"},
   {"arg":"source_auth_id","description":"the source auth CRS ID"},
   {"arg":"dest_auth_id","description":"the destination auth CRS ID"}
   ],

diff --git a/resources/function_help/json/translate b/resources/function_help/json/translate
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns a translated version of a geometry. Calculations are in the Spatial Reference System of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"},
+  "arguments": [ {"arg":"geometry","description":"a geometry"},
                  {"arg":"dx","description":"delta x"},
                  {"arg":"dy","description":"delta y"}
                ],

diff --git a/resources/function_help/json/x b/resources/function_help/json/x
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the x coordinate of a point geometry, or the x coordinate of the centroid for a non-point geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"x( geom_from_wkt( 'POINT(2 5)' ) )", "returns":"2"},
   { "expression":"x( $geometry )", "returns":"x coordinate of the current feature's centroid"}
   ]

diff --git a/resources/function_help/json/x_max b/resources/function_help/json/x_max
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the maximum x coordinate of a geometry. Calculations are in the spatial reference system of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"x_max( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') )", "returns":"4"}
   ]
 }
diff --git a/resources/function_help/json/x_min b/resources/function_help/json/x_min
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the minimum x coordinate of a geometry. Calculations are in the spatial reference system of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"x_min( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') )", "returns":"2"}
   ]
 }
diff --git a/resources/function_help/json/y b/resources/function_help/json/y
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the y coordinate of a point geometry, or the y coordinate of the centroid for a non-point geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"y( geom_from_wkt( 'POINT(2 5)' ) )", "returns":"5"},
   { "expression":"y( $geometry )", "returns":"y coordinate of the current feature's centroid"}
   ]

diff --git a/resources/function_help/json/y_max b/resources/function_help/json/y_max
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the maximum y coordinate of a geometry. Calculations are in the spatial reference system of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"y_max( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') )", "returns":"8"}
   ]
 }
diff --git a/resources/function_help/json/y_min b/resources/function_help/json/y_min
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the minimum y coordinate of a geometry. Calculations are in the spatial reference system of this geometry.",
-  "arguments": [ {"arg":"geom","description":"a geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a geometry"}],
   "examples": [ { "expression":"y_min( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') )", "returns":"5"}
   ]
 }
diff --git a/resources/function_help/json/z b/resources/function_help/json/z
@@ -3,7 +3,7 @@
   "type": "function",
   "groups": ["GeometryGroup"],
   "description": "Returns the z coordinate of a point geometry, or NULL if the geometry has no z value.",
-  "arguments": [ {"arg":"geom","description":"a point geometry"}],
+  "arguments": [ {"arg":"geometry","description":"a point geometry"}],
   "examples": [ { "expression":"z( geom_from_wkt( 'POINTZ(2 5 7)' ) )", "returns":"7"}
   ]
 }