update docstring

JuliaStats · Jan 15, 2021 · 5df46ef · 5df46ef
1 parent 6a0e905
commit 5df46ef
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/haversine.jl b/src/haversine.jl
@@ -1,10 +1,12 @@
 """
-    Haversine(radius)
+    Haversine([radius])
 
 The haversine distance between two locations on a sphere of given `radius`.
 
 Locations are described with longitude and latitude in degrees.
 The computed distance has the same units as that of the radius.
+The default value is 6371000 meters, which is the mean volumetric
+radius of Earth (source https://nssdc.gsfc.nasa.gov/planetary/factsheet/earthfact.html).
 """
 struct Haversine{T<:Real} <: Metric
     radius::T