summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorapense <apense@users.noreply.github.com>2015-06-29 23:07:06 -0400
committerapense <apense@users.noreply.github.com>2015-06-29 23:07:06 -0400
commitc3e6fb0e385bdd57ffd040f8e619375bce46318d (patch)
tree5d72e7c4614e523685f101c9a0b6c7401e78dde8
parent9e8c8f473bfeaab482c4342e9756a108b6d5803b (diff)
downloadNim-c3e6fb0e385bdd57ffd040f8e619375bce46318d.tar.gz
Corrected erroneous description
Hypotenuse is really just the euclidean norm
-rw-r--r--lib/pure/math.nim3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/pure/math.nim b/lib/pure/math.nim
index e36e509be..821ab738b 100644
--- a/lib/pure/math.nim
+++ b/lib/pure/math.nim
@@ -206,7 +206,8 @@ when not defined(JS):
   proc cosh*(x: float): float {.importc: "cosh", header: "<math.h>".}
     ## Computes the hyperbolic cosine of `x`
   proc hypot*(x, y: float): float {.importc: "hypot", header: "<math.h>".}
-    ## Computes the distance between `x` and `y`. Equivalent to ``sqrt(x*x + y*y)``.
+    ## Computes the hypotenuse of a right-angle triangle with `x` and
+    ## `y` as its base and height. Equivalent to ``sqrt(x*x + y*y)``.
 
   proc sinh*(x: float): float {.importc: "sinh", header: "<math.h>".}
     ## Computes the hyperbolic sine of `x`