summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Christopher Raaen <brian@brianraaen.com>2015-09-04 14:05:25 -0400
committerBrian Christopher Raaen <brian@brianraaen.com>2015-09-04 14:05:25 -0400
commite568bf1d69bef9d4cb1e4f806ab53a8b476a975b (patch)
tree1e3f3d646599db208e47099506faf44400b46ddf
parent8b51cbe99c6f40aa51ed66f422eaba098711ba7c (diff)
downloadnetaddr-e568bf1d69bef9d4cb1e4f806ab53a8b476a975b.tar.gz
updated documentation
-rw-r--r--netaddr/ip/__init__.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/netaddr/ip/__init__.py b/netaddr/ip/__init__.py
index 0141b26..07b5aca 100644
--- a/netaddr/ip/__init__.py
+++ b/netaddr/ip/__init__.py
@@ -1277,11 +1277,12 @@ class IPNetwork(BaseIP, IPListMixin):
def iter_hosts(self):
"""
- An generator that provides all the IP addresses that can be assigned
+ A generator that provides all the IP addresses that can be assigned
to hosts within the range of this IP object's subnet.
- for IPv4, the network and broadcast addresses are always excluded. \
- Any subnet that contains less than 4 IP addresses yields an empty list.
+ for subnets that contains less than 4 IP addresses /31 and /32 \
+ report in a manner per RFC 3021
- for IPv6, only the unspecified address '::' or Subnet-Router anycast \
address (first address in the network) is excluded.