linting

Author: anna-grim

src/segmentation_skeleton_metrics/utils/util.py

@@ -5,7 +5,6 @@
 @author: Anna Grim
 @email: [email protected]
 
-
 Code for helper routines.
 
 """
@@ -35,7 +34,7 @@ def mkdir(path, delete=False):
         Path of directory to be created.
     delete : bool, optional
         Indication of whether to delete directory at path if it already
-        exists. The default is False.
+        exists. Default is False.
     """
     if delete:
         rmdir(path)
@@ -66,7 +65,7 @@ def list_dir(directory, extension=None):
     directory : str
         Path to directory to be searched.
     extension : str, optional
-       Extension of filenames to be returned. The default is None.
+       Extension of filenames to be returned. Default is None.
 
     Returns
     -------
@@ -116,7 +115,6 @@ def read_zip(zip_file, path):
     -------
     str
         Contents of a TXT file.
-
     """
     with zip_file.open(path) as f:
         return f.read().decode("utf-8")
@@ -438,6 +436,8 @@ def kdtree_query(kdtree, xyz):
 
     Parameters
     ----------
+    kdtree : scipy.spatial.KDTree
+        KD-Tree to be searched.
     xyz : ArrayLike
         Coordinate to be queried.