Adding hints

Author: renier-30kft

haversine_calculation/haversine.py

@@ -1,10 +1,27 @@
 import math
 
 
-def haversine(lat1, lon1, lat2, lon2):
+def haversine(lat1: float, lon1: float, lat2: float, lon2: float) -> float:
     """
-    Calculate the great circle distance in kilometers between two points
+    Calculate the great circle distance in kilometers between two points 
     on the earth (specified in decimal degrees)
+    
+    Args:
+        lat1 (float): Latitude of the first point in decimal degrees
+        lon1 (float): Longitude of the first point in decimal degrees
+        lat2 (float): Latitude of the second point in decimal degrees
+        lon2 (float): Longitude of the second point in decimal degrees
+        
+    Returns:
+        float: Distance between the two points in kilometers
+        
+    Examples:
+        >>> round(haversine(40.7128, -74.0060, 51.5074, -0.1278), 2)
+        5570.22
+        >>> haversine(0, 0, 0, 0)
+        0.0
+        >>> round(haversine(0, 0, 90, 0), 2)
+        10007.54
     """
     # Convert decimal degrees to radians
     lat1, lon1, lat2, lon2 = map(math.radians, [lat1, lon1, lat2, lon2])