Add comment for surface_dist functions

dfsp-spirit · May 18, 2021 · 383b58d · 383b58d
1 parent 8c9a27b
commit 383b58d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/R/surface_dist.R b/R/surface_dist.R
@@ -1,4 +1,6 @@
-# Functions for computing Euclidian distance between vertex coordinates.
+# Functions for computing Euclidean distance between vertex coordinates.
+# These functions are not really specific for meshes as they simple work with vertex coords (=points) without
+# any knowledge or consideration of mesh topology (graph distance) or the surface (geodesic distance).
 
 #' @title Find vertex index closest to given query coordinate using Euclidean distance.
 #'