Skip to content

Commit c4fb2db

Browse files
committed
Merge pull request maxmind#34 from maxmind/greg/coordinates-doc-update
Add location usage warnings
2 parents 58d449d + 1345ac7 commit c4fb2db

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ install the `libmaxminddb C API <https://github.com/maxmind/libmaxminddb>`_.
3535
Please `see the instructions distributed with it
3636
<https://github.com/maxmind/libmaxminddb/blob/master/README.md>`_.
3737

38+
IP Geolocation Usage
39+
--------------------
40+
41+
IP geolocation is inherently imprecise. Locations are often near the center of
42+
the population. Any location provided by a GeoIP2 database or web service
43+
should not be used to identify a particular address or household.
44+
3845
Usage
3946
-----
4047

geoip2/records.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -267,14 +267,19 @@ class Location(Record):
267267
268268
.. attribute:: latitude
269269
270-
The latitude of the location as a floating point number.
270+
The approximate latitude of the location associated with the IP
271+
address. This value is not precise and should not be used to identify a
272+
particular address or household. This attribute is returned by all end
273+
points and location databases except Country.
271274
272275
:type: float
273276
274277
.. attribute:: longitude
275278
276-
The longitude of the location as a
277-
floating point number.
279+
The approximate longitude of the location associated with the IP
280+
address. This value is not precise and should not be used to identify a
281+
particular address or household. This attribute is returned by all end
282+
points and location databases except Country.
278283
279284
:type: float
280285

0 commit comments

Comments
 (0)