Merge pull request #4949 from lbartoletti/inclination_help

add missing help for inclination
qgis · Aug 2, 2017 · a0010a1 · a0010a1
2 parents 1887cff + d88a7f4
commit a0010a1
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/resources/function_help/json/inclination b/resources/function_help/json/inclination
@@ -0,0 +1,16 @@
+{
+  "name": "inclination",
+  "type": "function",
+  "description": "Returns the inclination measured from the zenith (0) to the nadir (180) on point_a to point_b.",
+  "arguments": [
+    {"arg":"point_a","description":"point geometry"},
+    {"arg":"point_b","description":"point geometry"}
+  ],
+  "examples": [
+	{ "expression":"inclination( make_point( 5, 10, 0 ), make_point( 5, 10, 5 ) )", "returns":"0.0"},
+	{ "expression":"inclination( make_point( 5, 10, 0 ), make_point( 5, 10, 0 ) )", "returns":"90.0"},
+	{ "expression":"inclination( make_point( 5, 10, 0 ), make_point( 50, 100, 0 ) )", "returns":"90.0"},
+	{ "expression":"inclination( make_point( 5, 10, 0 ), make_point( 5, 10, -5 ) )", "returns":"180.0"}
+
+  ]
+}