Fix distance function doc string

mozilla · Oct 15, 2019 · ddba691 · ddba691
1 parent 6cfb4d3
commit ddba691
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/alerts/geomodel/locality.py b/alerts/geomodel/locality.py
@@ -235,8 +235,8 @@ def remove_outdated(state: State, days_valid: int) -> Update:
 
 
 def distance(loc1: Coordinates, loc2: Coordinates) -> float:
-    '''Compute the distance between two localities, returning the geographical
-    distance in kilometres (KM).
+    '''Compute the distance between two points on the Earth, returning the
+    geographical distance in kilometres (KM).
     '''
 
     lat1 = math.radians(loc1.latitude)