new test function docu

drcandacemakedamoore · May 1, 2021 · 6bdf973 · 6bdf973
1 parent df8ba7d
commit 6bdf973
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/cleanX.py b/cleanX.py
@@ -339,7 +339,8 @@ def show_major_lines_on_image(pic_name):
 def find_big_lines(directory, line_length):
     """
     Finds number of lines in images at or over the length of 'line_legnth',
-    gives back a dataframe with this information
+    gives back a dataframe with this information. Note lines can fold back on
+    themselves, and every pixel is counted if they are all contiguous
 
     :param directory: Directory with set_of_images.
     :type directory: directory