Clarify that distances is initially empty

jni · Nov 14, 2020 · ff8cff0 · ff8cff0
1 parent ef6df1f
commit ff8cff0
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/skan/csr.py b/skan/csr.py
@@ -306,7 +306,8 @@ class Skeleton:
         The number of paths, P. This is redundant information given `n_paths`,
         but it is used often enough that it is worth keeping around.
     distances : array of float, shape (P,)
-        The distance of each path.
+        The distance of each path. Note: not initialized until `path_lengths()`
+        is called on the skeleton; use path_lengths() instead
     skeleton_image : array or None
         The input skeleton image. Only present if `keep_images` is True. Set to
         False to preserve memory.