Merge pull request #2705 from borisvassilev/gcddocs

Document explicitly the behaviour of math.gcd with float arguments

1 files changed, 3 insertions, 0 deletions

diff --git a/lib/pure/math.nim b/lib/pure/math.nim
index cb58ea39b..a9e9010f6 100644
--- a/lib/pure/math.nim
+++ b/lib/pure/math.nim
@@ -352,6 +352,9 @@ proc `^`*[T](x, y: T): T =
 
 proc gcd*[T](x, y: T): T =
   ## Computes the greatest common divisor of ``x`` and ``y``.
+  ## Note that for floats, the result cannot always be interpreted as
+  ## "greatest decimal `z` such that ``z*N == x and z*M == y``
+  ## where N and M are positive integers."
   var (x,y) = (x,y)
   while y != 0:
     x = x mod y