Update docstring

Co-authored-by: Alessandro Felder <alessandrofelder@users.noreply.github.com>
brainglobe · Dec 18, 2023 · 0119302 · 0119302
1 parent 69379cc
commit 0119302
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/brainglobe_segmentation/tracks/analysis.py b/brainglobe_segmentation/tracks/analysis.py
@@ -106,7 +106,8 @@ def run_track_analysis(
 
 def get_distances(spline, voxel_size=10):
     """
-    For a given spline, calculate the distance between each point
+    For a given spline, calculate the distance between each point.
+    Assumes a customisable isotropic voxel size (default 10) in microns.
     """
     distances = [0]
     for i in range(len(spline) - 1):