Clarify what the accuracy radius is

maxmind · Jul 5, 2016 · 3bdd773 · 3bdd773
1 parent dbb7e81
commit 3bdd773
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+2.8.0 (2016-XX-XX)
+------------------
+
+* All changes included in 2.8.0-rc1.
+* Updated documentation to clarify what the accuracy radius refers to.
+
 2.8.0-rc1 (2016-06-20)
 ----------------------
 

diff --git a/src/main/java/com/maxmind/geoip2/record/Location.java b/src/main/java/com/maxmind/geoip2/record/Location.java
@@ -68,8 +68,11 @@ public String getTimeZone() {
     }
 
     /**
-     * @return The radius in kilometers around the specified location where the
-     * IP address is likely to be.
+     * @return The approximate accuracy radius in kilometers around the
+     * latitude and longitude for the IP address. This is the radius where we
+     * have a 67% confidence that the device using the IP address resides
+     * within the circle centered at the latitude and longitude with the
+     * provided radius.
      */
     @JsonProperty("accuracy_radius")
     public Integer getAccuracyRadius() {