Added docstring to distance function.

deepfield · May 2, 2018 · dd2c15a · dd2c15a
1 parent bc7fe8b
commit dd2c15a
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/ibis/expr/api.py b/ibis/expr/api.py
@@ -3207,5 +3207,20 @@ def _table_drop(self, fields):
 
 def distance(from_lon, from_lat, to_lon, to_lat):
     """
+    Distance between origin longitude and latitude and
+    destine longitude and latitude
+
+    Parameters
+    ----------
+    from_lon : numeric column expr or float
+    from_lat : numeric column expr or float
+    to_lon : numeric column expr or float
+    to_lat : numeric column expr or float
+
+    Returns
+    -------
+    expr :
+        if scalar input, scalar type, same as input
+        if array input, list of scalar type
     """
     return ops.Distance(from_lon, from_lat, to_lon, to_lat).to_expr()