Merge pull request #69 from maxmind/adam/anonymizer-desc

Update descriptions for vpn/hosting provider attributes

Author: PatrickCronin

HISTORY.rst

@@ -3,6 +3,12 @@
 History
 -------
 
+2.9.1
+++++++++++++++++++
+
+* Updated documentation of anonymizer attributes - ``is_anonymous_vpn`` and
+  ``is_hosting_provider`` - to be more descriptive.
+
 2.9.0 (2018-05-25)
 ++++++++++++++++++
 

geoip2/models.py

@@ -328,13 +328,19 @@ class AnonymousIP(SimpleModel):
 
     .. attribute:: is_anonymous_vpn
 
-      This is true if the IP address belongs to an anonymous VPN system.
+      This is true if the IP address is registered to an anonymous VPN
+      provider.
+
+      If a VPN provider does not register subnets under names associated with
+      them, we will likely only flag their IP ranges using the
+      ``is_hosting_provider`` attribute.
 
       :type: bool
 
     .. attribute:: is_hosting_provider
 
-      This is true if the IP address belongs to a hosting provider.
+      This is true if the IP address belongs to a hosting or VPN provider
+      (see description of ``is_anonymous_vpn`` attribute).
 
       :type: bool
 

geoip2/records.py

@@ -560,14 +560,21 @@ class Traits(Record):
 
     .. attribute:: is_anonymous_vpn
 
-      This is true if the IP address belongs to an anonymous VPN system.
+      This is true if the IP address is registered to an anonymous VPN
+      provider.
+
+      If a VPN provider does not register subnets under names associated with
+      them, we will likely only flag their IP ranges using the
+      ``is_hosting_provider`` attribute.
+
       This attribute is only available from GeoIP2 Precision Insights.
 
       :type: bool
 
     .. attribute:: is_hosting_provider
 
-      This is true if the IP address belongs to a hosting provider.
+      This is true if the IP address belongs to a hosting or VPN provider
+      (see description of ``is_anonymous_vpn`` attribute).
       This attribute is only available from GeoIP2 Precision Insights.
 
       :type: bool