linting

backend/src/landmarks/cluster_manager.py

@@ -113,7 +113,7 @@ class ClusterManager:
             points = []
             for elem in result:
                 osm_type = elem.get('type')
-                
+
                 # Get coordinates and append them to the points list
                 _, coords = get_base_info(elem, osm_type)
                 if coords is not None :
@@ -217,7 +217,7 @@ class ClusterManager:
 
         # Define the bounding box for a given radius around the coordinates
         bbox = create_bbox(cluster.centroid, 300)
-        
+
         # Query neighborhoods and shopping malls
         selectors = ['"place"~"^(suburb|neighborhood|neighbourhood|quarter|city_block)$"']
 

backend/src/landmarks/landmarks_manager.py

@@ -298,6 +298,16 @@ class LandmarkManager:
 
     def description_and_keywords(self, tags: dict):
         """
+        Generates a description and a set of keywords for a given landmark based on its tags.
+
+        Params:
+            tags (dict): A dictionary containing metadata about the landmark, including its name,
+                    importance, height, date of construction, and visitor information.
+
+        Returns:
+            description (str): A string description of the landmark.
+            keywords (dict): A dictionary of keywords with fields such as 'importance', 'height',
+                        'place_type', and 'date'.
         """
         # Extract relevant fields
         name = tags.get('name')
@@ -314,7 +324,7 @@ class LandmarkManager:
         if importance is None :
             if len(tags.keys()) < 5 :
                 return None, None
-            elif len(tags.keys()) < 10 :
+            if len(tags.keys()) < 10 :
                 description = f"{name} is a well known {place_type}."
             elif len(tags.keys()) < 17 :
                 importance = 'national'
@@ -350,6 +360,17 @@ class LandmarkManager:
 
 
     def get_place_type(self, data):
+        """
+        Determines the type of the place based on available tags such as 'amenity', 'building',
+        'historic', and 'leisure'. The priority order is: 'historic' > 'building' (if not generic) > 
+        'amenity' > 'leisure'.
+
+        Params:
+            data (dict): A dictionary containing metadata about the place.
+
+        Returns:
+            place_type (str): The determined type of the place, or None if no relevant type is found.
+        """
         amenity = data.get('amenity', None)
         building = data.get('building', None)
         historic = data.get('historic', None)
@@ -369,6 +390,16 @@ class LandmarkManager:
 
 
     def get_date(self, data):
+        """
+        Extracts the most relevant date from the available tags, prioritizing 'construction_date',
+        'start_date', 'year_of_construction', and 'opening_date' in that order.
+
+        Params:
+            data (dict): A dictionary containing metadata about the place.
+
+        Returns:
+            date (str): The most relevant date found, or None if no date is available.
+        """
         construction_date = data.get('construction_date', None)
         opening_date = data.get('opening_date', None)
         start_date = data.get('start_date', None)