working split

backend/src/utils/take_most_important.py

@@ -1,15 +1,22 @@
 """Helper function to return only the major landmarks from a large list."""
 from ..structs.landmark import Landmark
 
-def take_most_important(landmarks: list[Landmark], n_important) -> list[Landmark]:
+def take_most_important(
+    landmarks: list[Landmark],
+    n_important: int
+) -> list[Landmark]:
     """
-    Given a list of landmarks, return the n_important most important landmarks
+    Given a list of landmarks, return the most important landmarks based on their attractiveness.
+    
     Args:
-    landmarks: list[Landmark] - list of landmarks
-    n_important: int - number of most important landmarks to return
+        landmarks (list[Landmark]): List of landmarks that needs to be truncated
+        n_important (int): Number of most important landmarks to return
+    
     Returns:
-    list[Landmark] - list of the n_important most important landmarks
+        list[Landmark]: List of the n_important most important landmarks
     """
+    if n_important == 0 :
+        raise ValueError('Number of landmarks to keep cannot be zero.')
 
     # Sort landmarks by attractiveness (descending)
     sorted_landmarks = sorted(landmarks, key=lambda x: x.attractiveness, reverse=True)