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

Update descriptions for vpn/hosting provider props
maxmind · Dec 21, 2018 · 0a9c0ca · 0a9c0ca
2 parents ca2ee9d + 7afda8a
commit 0a9c0ca
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+2.9.1
+------------------
+
+* Updated documentation of anonymizer properties - `isAnonymousVpn`
+  and `isHostingProvider` - to be more descriptive.
+
 2.9.0 (2018-04-10)
 ------------------
 

diff --git a/src/Model/AnonymousIp.php b/src/Model/AnonymousIp.php
@@ -7,10 +7,12 @@
  *
  * @property-read bool $isAnonymous This is true if the IP address belongs to
  *     any sort of anonymous network.
- * @property-read bool $isAnonymousVpn This is true if the IP address belongs to
+ * @property-read bool $isAnonymousVpn This is true if the IP address is
- *     an anonymous VPN system.
+ *     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 isHostingProvider property.
  * @property-read bool $isHostingProvider This is true if the IP address belongs
- *     to a hosting provider.
+ *     to a hosting or VPN provider (see description of isAnonymousVpn property).
  * @property-read bool $isPublicProxy This is true if the IP address belongs to
  *     a public proxy.
  * @property-read bool $isTorExitNode This is true if the IP address is a Tor

diff --git a/src/Record/Traits.php b/src/Record/Traits.php
@@ -39,12 +39,14 @@
  * {@link * https://www.maxmind.com/en/geoip2-anonymous-ip-database GeoIP2
  * Anonymous IP database} to determine whether the IP address is used by an
  * anonymizing service.
- * @property-read bool $isAnonymousVpn This is true if the IP address belongs to
+ * @property-read bool $isAnonymousVpn This is true if the IP address is
- * an anonymous VPN system. This property is only available from GeoIP2
+ * registered to an anonymous VPN provider. If a VPN provider does not register
- * Precision Insights.
+ * subnets under names associated with them, we will likely only flag their IP
+ * ranges using the isHostingProvider property. This property is only available
+ * from GeoIP2 Precision Insights.
  * @property-read bool $isHostingProvider This is true if the IP address belongs
- * to a hosting provider. This property is only available from GeoIP2
+ * to a hosting or VPN provider (see description of isAnonymousVpn property).
- * Precision Insights.
+ * This property is only available from GeoIP2 Precision Insights.
  * @property-read bool $isLegitimateProxy This attribute is true if MaxMind
  * believes this IP address to be a legitimate proxy, such as an internal
  * VPN used by a corporation. This attribute is only available in the GeoIP2