Update ip_address types in docs

It was incorrect. Longer term, it may make sense to drop the type info in the docs given that we have type hints in t he code.
maxmind · Jan 28, 2025 · 7615adb · 7615adb
1 parent 28c3b12
commit 7615adb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/geoip2/models.py b/geoip2/models.py
@@ -471,7 +471,7 @@ class AnonymousIP(SimpleModel):
 
       The IP address used in the lookup.
 
-      :type: str
+      :type: ipaddress.IPv4Address or ipaddress.IPv6Address
 
     .. attribute:: network
 
@@ -534,7 +534,7 @@ class ASN(SimpleModel):
 
       The IP address used in the lookup.
 
-      :type: str
+      :type: ipaddress.IPv4Address or ipaddress.IPv6Address
 
     .. attribute:: network
 
@@ -587,7 +587,7 @@ class ConnectionType(SimpleModel):
 
       The IP address used in the lookup.
 
-      :type: str
+      :type: ipaddress.IPv4Address or ipaddress.IPv6Address
 
     .. attribute:: network
 
@@ -628,7 +628,7 @@ class Domain(SimpleModel):
 
       The IP address used in the lookup.
 
-      :type: str
+      :type: ipaddress.IPv4Address or ipaddress.IPv6Address
 
     .. attribute:: network
 
@@ -705,7 +705,7 @@ class ISP(ASN):
 
       The IP address used in the lookup.
 
-      :type: str
+      :type: ipaddress.IPv4Address or ipaddress.IPv6Address
 
     .. attribute:: network
 

diff --git a/geoip2/records.py b/geoip2/records.py
@@ -651,7 +651,7 @@ class Traits(Record):
       running on. If the system is behind a NAT, this may differ from the IP
       address locally assigned to it.
 
-      :type: str
+      :type: ipaddress.IPv4Address or ipaddress.IPv6Address
 
     .. attribute:: is_anonymous