More doc updates.

[spline3.git] / src / Point.hs

diff --git a/src/Point.hs b/src/Point.hs
index 94bcd70f6e8c586f28a70e655c6bbd227ba1c801..bf6fe8ea9a2f6fc4e3ce59168cd7ce798981e894 100644 (file)
--- a/src/Point.hs
+++ b/src/Point.hs
@@ -68,6 +68,7 @@ distance p1 p2 =
       z2 = z_coord p2
 
 
--- | Returns 'True' if p1 'is_close' to p2, 'False' otherwise.
+-- | Returns 'True' if p1 is close to (within 'epsilon' of) p2,
+--   'False' otherwise.
 is_close :: Point -> Point -> Bool
 is_close p1 p2 = (distance p1 p2) ~= 0