Fix some ipaddress documentation errors (GH-6021) · python/cpython@e405096
@@ -236,7 +236,7 @@ write code that handles both IP versions correctly.
236236 groups consisting entirely of zeroes included.
237237238238239- For the following attributes, see the corresponding documention of the
239+ For the following attributes, see the corresponding documentation of the
240240:class:`IPv4Address` class:
241241242242 .. attribute:: packed
@@ -442,7 +442,11 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.
442442443443 .. attribute:: hostmask
444444445- The host mask, as a string.
445+ The host mask, as an :class:`IPv4Address` object.
446+447+ .. attribute:: netmask
448+449+ The net mask, as an :class:`IPv4Address` object.
446450447451 .. attribute:: with_prefixlen
448452 .. attribute:: compressed
@@ -588,13 +592,12 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.
588592589593 1. A string consisting of an IP address and an optional mask, separated by
590594 a slash (``/``). The IP address is the network address, and the mask
591- can be either a single number, which means it's a *prefix*, or a string
592- representation of an IPv6 address. If it's the latter, the mask is
593- interpreted as a *net mask*. If no mask is provided, it's considered to
594- be ``/128``.
595+ is a single number, which represents a *prefix*. If no mask is provided,
596+ it's considered to be ``/128``.
595597596- For example, the following *address* specifications are equivalent:
597- ``2001:db00::0/24`` and ``2001:db00::0/ffff:ff00::``.
598+ Note that currently expanded netmasks are not supported. That means
599+ ``2001:db00::0/24`` is a valid argument while ``2001:db00::0/ffff:ff00::``
600+ not.
598601599602 2. An integer that fits into 128 bits. This is equivalent to a
600603 single-address network, with the network address being *address* and
@@ -631,6 +634,7 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.
631634 .. attribute:: network_address
632635 .. attribute:: broadcast_address
633636 .. attribute:: hostmask
637+ .. attribute:: netmask
634638 .. attribute:: with_prefixlen
635639 .. attribute:: compressed
636640 .. attribute:: exploded