From 1d845c8a6ca1919fa05e9eacf2679848c7eb214e Mon Sep 17 00:00:00 2001
From: Martin Pergler <48919900+Houska1@users.noreply.github.com>
Date: Thu, 29 Jul 2021 06:40:18 -0400
Subject: [PATCH] Improve sinuosity help

Added explanation what this new expression actually calculates, based on help coded in /src/core/geometry/qgscurve.h
Also streamlined noted requirement that needs to be applied to a curve.
---
 resources/function_help/json/sinuosity | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/resources/function_help/json/sinuosity b/resources/function_help/json/sinuosity
index 642a297e581..7add34894c0 100644
--- a/resources/function_help/json/sinuosity
+++ b/resources/function_help/json/sinuosity
@@ -2,9 +2,9 @@
   "name": "sinuosity",
   "type": "function",
   "groups": ["GeometryGroup"],
-  "description": "Returns the sinuosity of a geometry. The geometry must be a curve (circularstring, linestring).",
+  "description": "Returns the sinuosity of a curve, which is the ratio of the curve length to the straight (2D) distance between its endpoints.",
   "arguments": [
-    {"arg":"geometry", "description": "The geometry."}
+    {"arg":"geometry", "description": "Curve (circularstring, linestring) whose sinuosity to evaluate"}
   ],
   "examples": [
     { "expression":"round(sinuosity(geom_from_wkt('LINESTRING(2 0, 2 2, 3 2, 3 3)')), 3)", "returns":"1.265"},